Project Source Code

Access the complete source code of the project on GitHub: Semester Project Repository.

• API Documentation: Auto-updated via Github actions, visible here
• DB Dumps: Database dumps for MongoDB and Neo4j, here here

Project Setup Instructions

Using AWK

If AWK is installed on your system, execute the following command from the project's root directory:

make run

Using Docker Compose

In the absence of AWK, execute the following docker-compose command from the project's root directory:

docker-compose -f deploy/docker-compose.yml -f deploy/docker-compose.dev.yml --project-directory . up --build

This command sets up docker containers, initializing the project and databases. It also loads test data into the databases. Look inside the Makefile, to see every command available.

Project Deployment

• Backend: Deployed on Azure, accessible here.
• Frontend: Hosted on Vercel, available here.

Running Tests

With AWK

make test

With Docker Compose

Execute the following command:

docker container exec $(docker ps | grep api-1 | awk '{print $1}') pytest ./rpg_api/tests/pytest -s

Test Data Scripts

Relational Database Scripts

Access the relational database scripts on GitHub:

• Main DB Scripts
• Startup Data Script
• Audit Log: Trigger/function in migration file here

Document and Graph Database Scripts

For Document and Graph databases, test data is managed by the backend application upon startup:

• MongoDB Startup Data Script
• Neo4j Startup Data Script