mirror of
https://github.com/Steffo99/sophon.git
synced 2024-12-22 23:04:21 +00:00
Stefano Pigozzi
4a4824395a
* ✨ Start notebooks app * 🔧 Fix nullable fields for notebooks * 🔧 Display user-friendly name for `Notebook`s * 🔧 Allow filtering in the notebook admin page * 🗒 Improve README * 🗒 Improve README again * ⬆ Add bluelib to the dependencies of the frontend * 🧹 Prepare a good frontend base for development * ✨ Port and improve useStorageState Original: https://github.com/pds-nest/nest/blob/main/nest_frontend/hooks/useLocalStorageState.js * 🧹 Remove React logo * ⬆ Add `docker` to the dependencies * ⬆ Add `axios` to the dependencies * 🔨 Mark `src` as sources root * ✨ Add API routes to view Notebooks * 🔧 Use a router for the `by-project` route * 🐛 Fix deletion failing on `SophonViewSet` * 🔧 Abstract notebook methods * ✨ Create a base docker client * 🚧 Proof of concept for notebook starter * 📔 Document the contents of the Django apps * 🚧 Incomplete container implementation * 🚧 Working container implementation * 💥 Leftovers from an experiment * ✨ Correct implementation of the proxy configuration (Apache config file is still missing) * 💥 Improve code * 💥 Improve more things * 🔧 Remove duplicated `/project` in project app urls * ✨ Add basic Apache proxy config file * 🔧 User should have sudo access on the notebook * ✨ Implement the Internet access field (currently ignored) * 🧹 Cleanup code
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# Sophon
|
|
|
|
_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).
|
|
|
|
### 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.
|
|
|
|
Run configurations for *running the backend*, *testing the backend* and *running the frontend* are included.
|
|
|
|
### 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/).
|