mirror of
https://github.com/Steffo99/sophon.git
synced 2024-12-22 06:44:21 +00:00
🗒 Add a better README
This commit is contained in:
parent
db6dd5b696
commit
f7c7c99e30
1 changed files with 39 additions and 1 deletions
40
README.md
40
README.md
|
@ -1,3 +1,41 @@
|
||||||
# Sophon
|
# Sophon
|
||||||
|
|
||||||
Django and React project for dataset collection
|
_A research hub for universities_
|
||||||
|
|
||||||
|
## Goal
|
||||||
|
|
||||||
|
The goal of this project is developing a platform that universities can use to **host** and **share** their _datasets_, _research projects_ and resulting
|
||||||
|
_papers_.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
The project consists of a **single-page-app with React** on the frontend and a **web API with Django Rest Framework** on the backend.
|
||||||
|
|
||||||
|
### Progress
|
||||||
|
|
||||||
|
Development progress is tracked on [issue #20](https://github.com/Steffo99/sophon/issues/20).
|
||||||
|
|
||||||
|
Development is currently focusing on the **backend**.
|
||||||
|
|
||||||
|
### Tools
|
||||||
|
|
||||||
|
Sophon is being developed using [IntelliJ IDEA Ultimate](https://www.jetbrains.com/idea/): its metadata is included in the `.idea` directory so that the code style and tools are consistent across all machines used during the development.
|
||||||
|
|
||||||
|
### Commits
|
||||||
|
|
||||||
|
Commits names are prefixed with a variant of [Gitmoji](https://gitmoji.dev/) which follows roughly this legend:
|
||||||
|
|
||||||
|
- ✨ New feature
|
||||||
|
- 🔧 Refactor or tweak
|
||||||
|
- 🐛 Bug fix
|
||||||
|
- 🧹 Cleanup
|
||||||
|
- 📔 Documentation
|
||||||
|
- 🗒 Readme
|
||||||
|
- ⬆ Dependency update
|
||||||
|
- 📦 Packaging
|
||||||
|
- 🔨 Tool update
|
||||||
|
- 🚧 Work in progress
|
||||||
|
|
||||||
|
### People
|
||||||
|
|
||||||
|
The project is currently being developed by [Stefano Pigozzi](https://github.com/Steffo99/), under the tutoring of [Francesco Faenza](https://github.com/Cicciodev) and [Claudia Canali](https://weblab.ing.unimore.it/people/canali/).
|
||||||
|
|
Loading…
Reference in a new issue