AdvLabDB/README.md

# Requirements
You need to have Python 3 and Poetry installed. To install Poetry, follow the 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
```

If you are starting the server for the first time or you want to drop and recreate the database then run:

```
python testDB.py
```

This 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. Now login and then navigate to `/admin` as shown on the home page after login.

## 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
The documentation will be done using Sphinx later.