Skip to content

Latest commit

 

History

History
81 lines (62 loc) · 1.42 KB

README.md

File metadata and controls

81 lines (62 loc) · 1.42 KB

This is my Dissertation Project.

View the report

I recieved 92.7% and won the Electronic Engineering and Computer Science Final Year Project Prize for Outstanding Achievement

The following installation guide assumes you are running Linux. It will run fine on Windows too but you may have to make some adaptations. Notably with entering the virtual environment.

Installation

Django

Install Python (distro dependant)

https://www.python.org/

Enter directory

cd rcr/backend

Create and enter a virtual environment

python -m venv venv
source venv/bin/activate

Install dependencies

pip install -r requirements.txt

Migrate database

python manage.py makemigrations

SvelteKit

Install npm (distro dependant)

https://www.npmjs.com/

Enter directory (cd ../../ if you are still in backend)

cd rcr/frontend

Install dependencies

npm install

Usage

I recomend running Django first to generate the types for SvelteKit

# rcr/backend/
python manage.py runserver
# rcr/frontend
npm run dev

Deployment

You will have to find instructions elsewhere if you plan on deploying this in build mode.

Here are the tools I used anyway:

https://kit.svelte.dev/docs/adapter-node 
nginx with the rcr config provided
gunicorn
namecheap
certbot

Postmark

You will need to add your own api key in the SvelteKit code.