Code Status

Classroom API

API is build using Express.

Getting Started

1. Make sure you have installed node and yarn to run the project.

   $ node --version

   $ yarn --version

2. Clone the application and navigate to the project directory.

3. Use yarn to install the dependent packages.

4. Setup environment variables for local environment in .env file by looking in .env.sample.

5. User yarn dev to run the project locally. Your local server runs on port 3000 if everything goes fine. And you are ready to go.

Contribution

Use Git Flow to contribute on the project.

Deployment

TravisCI has been used for CD. So, all you need to do is merge the code in master branch in order to deploy the code.