Setup

1. Clone this project: git clone https://github.com/SeanOverton/django-csit314.git
2. [OPTIONAL but recommended] Recommend that you create and activate a virtual env in your terminal here before running the pip install. This process will vary depending on OS so please look into it before you try this: https://docs.python.org/3/library/venv.html#:~:text=A%20virtual%20environment%20is%20a,part%20of%20your%20operating%20system.
3. Install dependencies: pip install -r requirements.txt
4. Run python -c "import secrets; print(secrets.token_urlsafe())" to generate a secret key.
5. Copy the contents of .env-EXAMPLE and add your secret key generated from the last command into this file. Save this file as .env in the root directory. File contents should look like DJANGO_SECRET_KEY=<your_secret_key>
6. python manage.py makemigrations
7. python manage.py migrate
8. Run the server locally: python manage.py runserver

To access the admin dashbaord on the server:

1. python manage.py createsuperuser
2. This will prompt you for user details. Complete this and remember these details.
3. Navigate to: http://localhost:8000/admin/ to login to the admin dashboard and access DB directly.

To test server (postman):

1. Import PostmanRequestsCollection.json into Postman app.
2. Send a sign up request.
3. Send a login request.
4. This will return a token that needs to be added to any of the other requests as a header to authenticate with the server. Authorization: Token <your_token>

NOTE:

• Environment File Required.