Foxtrot is a client/server app for university students, a platform for us to create and share grading schemes for exams, assignments and courses. Never again will you or your peers have to waste time and risk error calculating by hand what you need on your final to score that A+.
You can check out our project demo here.
Clone the repository, cd into it if necessary, and install the requirements (assuming you already have npm installed on your machine):
git clone https://github.com/spectraldoy/CS35LFinalProject
cd ./CS35LFinalProject
npm installIf you do not already have a MongoDB Atlas account, create one here.
Create a new project and navigate to the Clusters tab under DATA STORAGE. Click the "Create a New Cluster" button and choose a provider for your database (currently, the app has only been tested with AWS) and create your cluster.
Return to the Clusters page and click on the CONNECT button for your newly created cluster.
On the "Setup connection security" step, you may want to specify 0.0.0.0/0 as a connection address to simplify access through various networks. Additionally, remember to save your username and password for the cluster.
Once on the "Choose a connection method" step, select the "Connect your application" option. From there, choose "Node.js" as the driver and "3.6 or later" as the version. Copy the provided connection string to your clipboard.
Now, within the root directory of the cloned repository, create a file called ".env". Within it, define the variable DB_CONNECTION_STRING to be the string you copied from MongoDB. An example .env file would look like this:
DB_CONNECTION_STRING = "mongodb+srv://username:password@schemedata.zculb.mongodb.net/myFirstDatabase?retryWrites=true&w=majority"
Make sure to substitute in your cluster username and password into the string.
The database should now be ready for use.
In the root directory, simply run:
npm run devwhich uses concurrently to start the client-side app as well as listen on the server. With this, the app should open in your browser (currently, the app has been tested on Chrome and Safari). Note that it may take some time for npm to start the server. If it does not, enter http://localhost:3000/ into your browser and you should be good to go. Once the app has opened, you may need to create a Foxtrot account.
This project was bootstrapped with Create React App. We used Express to route GET and POST requests on a Node.js server to our MongoDB collections.
Our user interface is made possible by Material UI, and special thanks to a friend for designing our logo.
This CS35L Spring 2021 Final Project is brought to you by: