System Manual
This software is dockerized and deployed.
The project is ready and deployed on a GCP Virtual Machine. Also, one can clone the main branch of the repository. By the help of dockerization one can run the whole project locally. When deploying the project with docker the project creates 3 different containers for backend, frontend and database.
Project dockerization is orchestrated by docker-compose 3.7 version. After dockerization there are 3 containers we have.
- Backend Container:
- Based on python:3.11-slim-buster image
- Installs required packages via requirements.txt
- Copies necessary folders/files
- Runs migrate and runserver commands
- Frontend Container:
- Based on node:18-buster-slim image
- Copies necessary folders
- Installs necessary packages via npm install command
- Runs npm start command
- Database Container:
- Based on postgis/postgis:15-3.4 image
- docker-compose.yml URL: https://github.com/SWE574-Fall2023-Group1/SWE574-Fall2023-G1/blob/main/docker-compose.yml
- Backend Dockerfile URL: https://github.com/SWE574-Fall2023-Group1/SWE574-Fall2023-G1/blob/main/backend/Dockerfile
- Frontend Dockerfile URL: https://github.com/SWE574-Fall2023-Group1/SWE574-Fall2023-G1/blob/main/backend/frontend/Dockerfile
git clone https://github.com/SWE574-Fall2023-Group1/SWE574-Fall2023-G1.git
cd SWE574-Fall2023-G1
make
make up
The following UML diagram illustrates the system's current architecture. Further diagrams will be made available as changes are made to the system.
