mirror of
https://codeberg.org/Mo8it/AdvLabDB.git
synced 2024-11-08 21:21:06 +00:00
66 lines
1.8 KiB
Markdown
66 lines
1.8 KiB
Markdown
[](https://github.com/psf/black)
|
|
[](https://pycqa.github.io/isort/)
|
|
|
|
# Requirements
|
|
You need to have Python version >=3.9 and Poetry installed. To install Poetry, follow the official instructions [here](https://python-poetry.org/docs/#installation).
|
|
|
|
# Start server
|
|
Every following instructions has to be followed every time before starting the server if not mentioned otherwise.
|
|
|
|
Navigate to the directory `advlabdb` where the repository is cloned and run:
|
|
|
|
```
|
|
git pull
|
|
```
|
|
|
|
to pull the latest changes from the remote repository. Then run:
|
|
|
|
```
|
|
poetry install
|
|
```
|
|
|
|
to install (or update) all needed packages to the virtual environment. Now enter the virtual environment:
|
|
|
|
```
|
|
poetry shell
|
|
```
|
|
|
|
**ONLY IF** you are starting the server for the first time without an existing database or you want to **!drop and recreate!** the database then run:
|
|
|
|
```
|
|
# CAUTION, running this drops an existing database!
|
|
python testDB.py
|
|
```
|
|
|
|
This (re-)creates the database with some elements for testing.
|
|
|
|
Now you can start the server by running:
|
|
```
|
|
python run.py
|
|
```
|
|
|
|
This command will print out the URL for accessing the local server. For example:
|
|
|
|
```
|
|
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
|
|
```
|
|
|
|
This URL leads to the home page where you can login with this testing admin account:
|
|
- email: admin@protonmail.com
|
|
- password: admin
|
|
|
|
# To-Do:
|
|
- Rest of admin model views
|
|
- Experiments history for students
|
|
- Assistants space
|
|
- Homepage text changeable
|
|
- Email integration?
|
|
- 2FA?
|
|
- Students code for getting information?
|
|
- Database scripts
|
|
- Logging
|
|
- Documentation with Sphinx
|
|
- Production server configuration
|
|
- Backups
|
|
- Licence (GNU AGPLv3?)
|
|
- Privacy policy
|