PWP SPRING 2021

Lines API

Group information

• Student 1. Sami Harju [email protected]
• Student 2. Teemu Hannnula [email protected]
• Student 3. Tuukka Veteli [email protected]

Remember to include all required documentation and HOWTOs, including how to create and populate the database, how to run and test the API, the url to the entrypoint and instructions on how to setup and run the client

Application installation

These instructions were made for Ubuntu 20.04 running Python 3.9.

1. Create a virtual environment (optional)

   python -m venv venv
   source venv/bin/activate

2. Install dependencies.

   ./install.sh

3. Initialize database or apply new migrations

   ./migrate.sh

4. Run only database tests

   pytest -v -m models

5. Run all tests and check code syntax

   ./test.sh

6. Start application

   ./run.sh

7. Find api entrypoint with a client of your choice

   http://localhost:8000/api/

Web Client

See https://github.com/Stugeh/LinesClient

Admin site

Create a superuser with

python manage.py createsuperuser

Access admin site via http://localhost:8000/admin

Apidocs

Once server is up and running, check the self-hosted docs at http://localhost:8000/docs