The application consists of an Express server (analysis-tool-server) and a React client (analysis-tool-frontend).
- The server requires a .env environment file with a single variable, 'MONGO_URI', to which a MongoDB application URI is required to be assigned. Ex: MONGO_URI='your_mongo_db_uri'. Highly recommend watching through the provided video made by a previous year team for this process.
- The server has been configured to run on port 3001 and the client on port 3000. These ports would need to be free of any other process in order to run the applications. Alternatively, both applications can be configured to run on a custom port.
- Having the latest version of python installed.
- Clone the repository onto your device.
- Run the command 'npm install' at the root of the server, 'analysis-tool-server'.
- Once all dependencies are done installing, run 'npm start' to start up the server on port 3001.
- There is a batch script that includes all Python dependencies; please double-click it. If you are having some issues with this, look into debugging around your environment path, or you may want to look into using the --user flag when installing; this just depends on how you've set up Python.
- If you want to access our API documentation, open up your browser and navigate to http://localhost:3001/docs
- Run the command 'npm install' at the root of the client, 'analysis-tool-front-end'.
- Once all dependencies are done installing, run 'npm start' to start up the server on port 3000.
- On server start, you should be automatically navigated to the application in your browser. If this does not occur, please open up your browser and navigate to http://localhost:3000.