-
Notifications
You must be signed in to change notification settings - Fork 0
Installation and setup
- Python (recommended >= 3.8)
- pip (Latest version 21.3 used as of 11/3)
- npm (Latest version 6.14.4 used as of 11/3)
A terminal environment capable of handling bash scripts. To install all required packages, while within the context of the project root directory, run:
./setup.sh This will handle all npm and pip package installations required for both the front and backend.
If the script says "command not found" or something similar, run chmod +x ./setup.sh. This grants the script execution privileges. Depending on your setup, this may occur for the boot_dockerless files, amongst others. The same command will fix the issue.
To run a testing environment, run:
./startup.sh This will run flask and npm simultaneously, booting both the front and backend. Note - npm takes substantially longer to boot compared to flask.
To ensure that flask is no longer occupying a port, run:
./shutdown.sh This will search for any active process containing "flask" and kill the process.
Download MongoDB Community Server Follow the Installion Guide In app.py set 'host' string to 'localhost'
Recommended: Use a GUI such as Studio 3T to more easily interact with the database
Create account for MongoDB ** If current MongoDB Atlas owner adds your username/password to the cluster, skip to step 4 **
Follow MongoDB Atlas Setup Guide to create a database collection for hosting applications In app.py set 'host' string to your MongoDB Atlas connection string Create an application.yml file in the /backend directory with the specifications: username: password: For testing through CI to function as expected, repository secrets will need to be added through the settings. Create individual secrets with the following keys/values: MONGO_USER: MONGO_PASS: