This projects consists of three major components, a ReactJS frontend, ExpressJS backend, and MongoDB atlas connection. There are two different ways to run the application in a development environment. THIS IS OUT OF DATE SORRY - THE FLASK API NO LONGER EXISTS
Clone the repository, and open in VSCode / dev environment of choice. If you need help msg me.
This method is easier, but can be less ideal for development depending on your specific setup. On a Windows computer, you will not be able to hot reload the code, meaning code changes will not be immediately reflected upon saving the file. This is not an issue on macs.
However, using the docker environment will allow you to run all the different parts of the app with one command. Although the routing will probably be configured for the other environment because I'm doing most of the dev on a windows computer...
Install DockerDesktop. Follow all instructions then continue to step 2.
From the root of the repository, run docker-compose up
This should build the different images and run them in one environment. If you are one a mac, code changes will be reflected (at least in the React App, haven't set up nodemon for Express) upon save (hot reload). If not, you will have to close the environment with 'docker-compose down' or exit the process with Ctrl+C in the terminal (VSCode Powershell). Can also be stopped from docker desktop.
Run all the processes seperately. Somewhat of a pain, but does give greater control, and has hot reloading on a windows machine (again, no nodemon on the Express API so...). There is a lot more setup work though. HIGHLY recommend VSCode if you're going to do this (though to be honest I recommend it for the other way as well too...)
Use Ctrl+` to open your VSCode terminal. Split it into three different terminals by rightclicking on the 'powershell' and clicking 'Split Terminal' two times. We will now enter each different directory, one in each terminal. Do this by typing cd frontend, cd backend, and cd API in each terminal. (Note: As of right now, the API doesn't exist. It will hopefully soon though.)
Now we need to install all the dependencies. If you don't have yarn (or npm ig)installed, do that now. Also make sure you have a recent version of python installed.
In the frontend terminal, type yarn install (or npm install if you don't use yarn for some reason). Type the same thing in the backend terminal.
The Flask API is slightly more work because first you need to create and enter a python virtual environment. To create an environment, type py -m venv ./venv. Wait for this process to complete, the start the virtual environment by typing ./venv/Scripts/Activate.ps1. Once the virtual environment has started, install the dependencies with pip install -r requirements.txt.
You might have to install pip, update python, or add it to path. Also posssible that you will have to type python -m venv ./venv instead of py.
Now to start the different parts.
In the frontend, type yarn start. Do the same in the backend. In the API, type py app.py.
Now everything should be running.