Update: Our application has been deployed in Google's Kubernetes Engine (GKE). We have also performed load testing by sending 100 Billion request per second on average and the kubernetes cluster was able to successfully create 8 replicas of the application. Please refer to load_test.yaml
for more details.
Official links can be found here:
- Node.js - Backend framework used
- Passport.js - Used to ensure login authentication
- React.js - Web interface framework
- MongoDB - Database platform for user data
- Mocha - Unit testing framework
- Kubernetes - Kubernetes for deployment.
This project has yet to reach the stage of a minimum viable product. However, more detailed instructions to come on how to install the project on your local machine. To contribute to our project, kindly clone or fork a git repository on to begin.
Before working on this project, ensure that there is a MongoDB instance running on the local machine at the default port 27017
.
Navigate to the application_code directory run the command npm install to install all the packages required for this project to run.
Navigate to the application_code directory run the command node app.js. As mentioned in the Prerequisite section, make sure that you already have a MongoDB instance running before you run this command.
Open a web browser, and navigate to http://localhost:3000
to view the app.
Run the command npm test to run all the unit tests written. To generate code coverage report run the command npm run test-with-coverage
For more information, please read our REQUIREMENTS.md
If you would like to contribute to our project, please refer to CONTRIBUTING.md for instructions.