mirror of
https://codeberg.org/Mo8it/AdvLabDB.git
synced 2024-12-20 23:41:20 +00:00
Updated README
This commit is contained in:
parent
82ee852469
commit
dbfc488e8e
2 changed files with 24 additions and 9 deletions
31
README.md
31
README.md
|
@ -22,13 +22,14 @@ to install (or update) all needed packages to the virtual environment. Now enter
|
||||||
poetry shell
|
poetry shell
|
||||||
```
|
```
|
||||||
|
|
||||||
If you are starting the server for the first time or you want to drop and recreate the database then run:
|
**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
|
python testDB.py
|
||||||
```
|
```
|
||||||
|
|
||||||
This creates the database with some elements for testing.
|
This (re-)creates the database with some elements for testing.
|
||||||
|
|
||||||
Now you can start the server by running:
|
Now you can start the server by running:
|
||||||
```
|
```
|
||||||
|
@ -41,11 +42,25 @@ 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)
|
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
|
||||||
```
|
```
|
||||||
|
|
||||||
This URL leads to the home page. Now login and then navigate to `/admin` as shown on the home page after login.
|
This URL leads to the home page where you can login with this testing admin account:
|
||||||
|
- email: admin@protonmail.com
|
||||||
|
- password: admin
|
||||||
|
|
||||||
## Pay attention to:
|
~# Pay attention to:~
|
||||||
- If you create a semester, then you have to set it as the active semester for you as current user.
|
|
||||||
- Many "model views" are not done yet. There is still a lot to be done.
|
|
||||||
|
|
||||||
# Documentation
|
# To-Do:
|
||||||
The documentation will be done using Sphinx later.
|
- Rest of admin model views
|
||||||
|
- Validators
|
||||||
|
- Experiments history for students
|
||||||
|
- Check deactivation and deletion of users and roles (Don't lock out admins!)
|
||||||
|
- Change semesters label (SS WS)?
|
||||||
|
- Assistants space
|
||||||
|
- Email integration?
|
||||||
|
- 2FA?
|
||||||
|
- Students code for getting information?
|
||||||
|
- Global configuration
|
||||||
|
- Database scripts
|
||||||
|
- Logging
|
||||||
|
- Documentation with Sphinx
|
||||||
|
- Production server configuration
|
||||||
|
- Backups
|
||||||
|
|
|
@ -75,7 +75,7 @@ def assistants():
|
||||||
["Building", "row.building"],
|
["Building", "row.building"],
|
||||||
["User", "row.user"],
|
["User", "row.user"],
|
||||||
["Appointments", "row.appointments"],
|
["Appointments", "row.appointments"],
|
||||||
["Experiemt marks", "row.experiment_marks"]]
|
["Experiment marks", "row.experiment_marks"]]
|
||||||
|
|
||||||
table = makeTable(headerAndDataList=headerAndDataList,
|
table = makeTable(headerAndDataList=headerAndDataList,
|
||||||
rows=Assistant.query.filter(Assistant.user_id != None).all())
|
rows=Assistant.query.filter(Assistant.user_id != None).all())
|
||||||
|
|
Loading…
Reference in a new issue