H2S Student Management API

This API connects the H2S Student Management App to both our own firebase database & 42's Intra API.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project.

Prerequisites

• Node
  • version 12.7

If you need to upgrade / downgrade your Node Js version, you can use nvm

• nvm install 12.7

• You must get the .env file from Kai and place it in the root of this repository folder

Installing & Starting

nvm use 12.7
npm install
npm start

For live updates in development use npm run start-watch

Contributing

Please read CONTRIBUTING.md for details on how to best get involved, and the process for submitting pull requests to us.

Deployment

Our API is deployed using Heroku. Any changes made on the master branch are tested through Travis CI, passing builds are automatically deployed. Once a branch is merged with master it must be manually tested & deployed.

Built With

Express Server Framework
Firebase Database

Additional Libraries

body-parser
bottleneck
cors
Moment Timezone
request-promise

Development & Testing Tools

Postman
dotenv
jest
nodemon
supertest

Authors

• Donald Stolz - Intial work & design