Flywheel 🚗

About ✍️

To build flywheel, we utilized a React front end which communicates to our Node.js/Express backend API via HTTP Requests. Our server/API directly communicates with the database via Mongoose queries, and we chose MongoDB as our (NoSQL) cloud database.

Live Demo ☁️

Flywheel was deployed on Heroku, and can be accessed here.

API Documentation 🚀

The backend API was documented and tested using the Postman app. The documentation which was generated can be found here.

To Run 🖥️

After you have cloned this git repository, please ensure you have npm and node.js installed. Next, please type

cd client
npm install
cd ..
npm install

to install all necessary node modules as specified in the client and server's package.json and then type

npm run dev

to run both the backend API/server (on localhost:5000) and the frontend client (on localhost:3000).