Skip to content

thakursaurabh1998/fantasy-soccer

Repository files navigation

Soccer Manager

The application is deployed on heroku. https://fantasy-soccer-th98.herokuapp.com

You can also browse the API documentation on Postman. https://documenter.getpostman.com/view/3481116/UVRHiiCC

Tech Stack

  1. NodeJS - JavaScript engine for running back end JS code
  2. MongoDB - Database, cloud service being used is Atlas by MongoDB
  3. Mongoose - ODM for MongoDB
  4. ExpressJS - Web Framework used to create API
  5. Jest and Supertest - Testing framework
  6. Heroku - For hosting the application

Good design decisions

  • Graceful Shutdown of the API server, ensures that there is no interruption in request processing of the APIs in case of restart/redeploy.
  • Schema declaration using mongoose.
  • Request schema validation is done using Joi.

Possible improvements

  • Typescript could have been used as the language of choice because of a lot of advantages, but because this was a small project I decided to go with JS which also helped in fast development. But I recommend using Typescript for big projects.

Environment variables

  • .env file is used to set environment variables..
  • .env example is given in the .env.example file

Testing

Following are the instructions to run tests:

To run these tests you should have a running Mongo DB service, add the URL in .env file.

source .env
npm install
npm test

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published