Getting Started Mtp-K12Online-backend

Tools and Platforms

1. MongoDB https://account.mongodb.com
2. Express Js yarn install express --save
3. Node Js https://nodejs.org/en/download/
4. yarn https://classic.yarnpkg.com/en/docs/install/#windows-stable
5. Heroku https://www.heroku.com/nodejs
6. PostMan
7. GitHub, dockerhub,

Available Scripts

Once the repo is clonned succesfuly,and the required environments are install at least Node js , execute following scripts.

yarn 
yarn start

the api will run in the development mode.
Open http://localhost:3000/api access the apis in postman.

Example:
http://localhost:3000/api/login
http://localhost:3000/api/sinup

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Learn More

You can learn more in the Mern Stack.

To learn Node Js, check out the Node Js.

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Contribution

If one want to contribute to this open source project, few things one will need to consider are below.

• Once you clonned the project as described above from it's remote Github Repository, Visit the project in the remote repo to see all the to do task. This will help keep you upto date on what needs to be done, what's being done and what has been done.
• You can pick one of the task on todo or create a task you'd recommend to be implemented on the project.

Branching Rules.

• Once you decided which task to pick up or created, branch from the master and create your branch in this format mtp/taskName
• A pull request will be required for your code to be merged into the master by the adminstrator.
• Once the pull request is succesful, the task will automatically be moved to done.