Skip to content

aut-shuttle/api

Repository files navigation

Logo

AUT Shuttle App's API

Scalable and Robust

Unit Testing Description
Unit Testing We follow a test-driven development process.
We send emails with MailGun. MailGun
MailGun We generate fake user data using Faker.js (for testing of course).
Our database enables efficiency and handles volume. Database Schema
PayPal We enable account top-ups using PayPal.
We deploy to and host on Heroku. Heroku Deploy

Getting Started

Prerequisites

To ensure you have the required dependencies installed, run:

npm install

Be sure to create a .env file in the root directory with the configuration outlined in .env.example, NEVER check the .env file into GitHub.

Formatting the Code

To format the code, run:

npm run format

Unit Testing the Code

To unit test the code, run:

npm run test

Starting (running) the API

To start (run) the API and handle requests in production, run:

npm start

To start (run) the API and handle requests in development (with logging), run:

npm run dev