chill5018/flightapp-api

URLs

The backend system is deployed to here

The API documentation can be inspected here

The build logs - Travis CI

Key Technologies

Core

• Node.js v8.11.2
• Express.js v4.16.4

Databases

• PostgresSQL
• Sequelize

Testing

• mocha
• chai

Setup

Prerequisite

• Homebrew (MacOS)
• Chocolatey (Windows)

Node

1. Install nvm with brew install nvm.
2. Install node 8.11.2 with nvm install 8.11.2.
3. From the root directory of this project, run nvm use 8.11.2.
4. Run npm install

Database

1. Install PostgreSQL on your local machine. The instructions for this very from operating system to operating system.

$ brew install postgresql

2. Start PostgreSQL and run on startup.

$ brew services start postgresql

3. Ensure a root user exists on PostgreSQL with no password:

$ psql --dbname=postgres
postgres=# CREATE USER root;
postgres=# ALTER USER root WITH SUPERUSER;

4. Create the database by running:

$ npm run db:create

5. Create the database tables by running:

$ npm run db:migrate

Testing

To run the tests, simply run

$ npm run test

To generate the code coverage

$ npm run test:coverage

flightapp-api's Issues

[HIGH PRIORITY] - Add data to the Database

Create a seed file to populate the database with some content. It is recommended that we use dates starting in february. So that this does not have to be updated for the exam.

Define Unit Tests for Models

Use #15 to define models for TDD

User should be able to select a valid flight to proceed with booking

User Should be able to Book a Flight

The process of actually purchasing a flight

System Should Return Appropriate Results for One-Way and Round Trip Tickets

Administrator should be able to update flight info

An admin portal to update the flight information

User Should Be able to Review Previous Bookings

Use email address to find all bookings associated with that email

Handle User Authentication

• Define User Model

• Name
• Email
• Password

• Define User Relationships

• User Has Many Bookings
• User has Payment Details

• Define Auth Endpoints

• Use Bcrypt + JWT Token or Cookies for Auth.

User should be able to enter their personal details to attach to booking

The User should be notified if the flight is full before booking is completed

Define API Endpoint Tests

Should test that the API endpoint responds with the correct data.

For this we can use supertest

Handle Payment Details

• We need to securely store a users credit card / payment information
• We need to securely pass this information between the client and the server. (Symmetric / Asymmetric Encryption + TLS)
• Check Sum, to ensure the integrity of the credit card information

🚨 🚨 [HIGH PRIORITY] - User Should be able to Search for a Flight

We need to be able to send a query to the API where the Client can query a list of available flights using the following query params:

GET /flights?departureCity="Copenhagen"&arrivalCity="New York City"&departureDate="21/12/2018"&returnDate="21/12/2018

User should be able to Search for Flights

A user should be able to select a Departure City, and an Arrival City, for a specific date.

[HIGH PRIORITY] Enable Cors for the API

Please enable cors on the express server so that we can make requests to the API on Heroku.

express.use(cors({
  origin: '*',
  credentials: true
}));

User should be able to enter Arrival City

Define Models

{
  "originName": "Copenhagen",
  "originCode": "CPH",
  "destinationName": "New York City",
  "destinationCode": "JFK",
  // CPH, JFK, LGA, NWK, SWF (Norwegian)
  "airports": {
    "id": "int",
    "name": "String"
  },
  // Airline Selling Ticket (SAS, Norwegian, British Airways, American Airlines, Turkish Air)
  "airline": { 
    "id": "int",
    "name": "String",
    "offerIndex": ["OfferId - Int"]
  },
  // Ticket
  "offer": {
    "id": "int",
    "price": "Double - BaseCurrency [EUR, DKK, USD]",
    "flightIndex": ["flightId"]
  },
  // Booking
  "flight": {
    "id": "int",
    "airlineIndex": "airlineId",
    "flightNumber": "string",
    "departureDateTime": "timestamp",
    "arrivalDateTime": "timestamp",
    "destinationIndex": "airportId",
    "originIndex": "airportId"
  }
}

Reconfigure sequelize setup

Currently, we use 2 types of configs for the sequelize commands. We need to be consistent and only use config/config.json file and avoid using the .env files for that matter

Generate Seed Files to have more data

We need data in the app, so need to create some seed files so that the clients can make queries.

http://docs.sequelizejs.com/manual/tutorial/migrations.html#creating-first-seed

Define Controllers With Endpoints

GET - api/v1/airlines --> Returns all available airlines with flights
POST - api/v1/airlines --> Create city with flights

GET - api/v1/airports --> Returns all available airports with flights
POST - api/v1/airports --> Create airport

GET - api/v1/cities --> Returns all available cities with flights
POST - api/v1/cities --> Create city with flights

Primary Endpoint
GET - api/v1/flights --> Returns all available flights

params: {
  "origin": "String",
  "destination": "String",
  "departureDate": "Long",
  "returnDate": "Long",
  "ticketCount": "Int"
}

POST - api/v1/flights --> Create flight

GET - api/v1/offers --> Returns all available offers with flights
POST - api/v1/offers --> Create offer

Update Readme

The Readme does not reflect our project. It needs to be updated.

How to initialize the project, how to run the project locally. Where to find the deployed version, a Link to the available routes.

System should generate a booking ID