suneetk92 / toppr_backend_hiring_challenge Goto Github PK

Please find below the steps:

1. Clone the repository. git clone "https://github.com/suneetk92/Toppr_Backend_Hiring_Challenge.git".
   
2. Open the console/cmd/Terminal and go to the Toppr_Backend_Hiring_Challenge folder and execute "npm install" to install all required packages.
   
3. a. If you want to connect to local mongoDB instance then execute all the queries provided in MongoDB Queries.txt file.
   
4. b. Then change the value of "database" in config.js to point to the local instance.
   
5. Execute "node server.js" in console to start the server.
   
6. Now visit the localhost:1337/list /count /stats to access the GOT API. Or else you can access the api from heroku server(https://toppr-backend.herokuapp.com/).
   List - https://toppr-backend.herokuapp.com/list
   Count - https://toppr-backend.herokuapp.com/count
   Stats - https://toppr-backend.herokuapp.com/stats
   
7. Screenshots are added in /Screenshots folder.