Qts Software Engineering Tech Task

This repository is a web service that will return flights matching the specified criteria.
The web service will return:

1. All flights
2. All flights by airline code
3. Provide the interface to create new flights

Prerequisites

Software required to run this project is:

1. IntelliJ IDEA (https://www.jetbrains.com/idea/download)
2. Postman (https://www.postman.com/downloads)

Getting Started

If downloading the zip from this repository, firstly download, then unzip the file named "QtsWebService-main.zip".
Using IntelliJ IDEA, locate and open the directory named "QtsWebService-main".

Installing

To compile and run the project:

1. From the left project structure, expand "src->main->kotlin->com.flights.demo"
2. Select "FlightsApplication.kt"
3. From the menu select "Run->Run"
4. In the presented dialogue options, select "FlightsApplication.kt"

The SpringBoot application server will start.

To post new flight data:

1. Open Postman
2. Import the following cURL statement:

curl --location --request POST 'http://localhost:8080/flight' \
--header 'Content-Type: application/json' \
--data-raw '{
    "flightNumber":"QF401",
    "airlineCode":"QF",
    "departurePort":"MEL",
    "arrivalPort":"SYD",
    "departureTime":"2020-06-12T09:30:23Z",
    "arrivalTime":"2020-06-12T10:25:23Z"
}'

3. Within the Postman client, press Send.

To provide more data, the following data can be placed into the Body of the previous cURL statement and re-sent.

{
    "flightNumber":"EK555",
    "airlineCode":"EK",
    "departurePort":"BKB",
    "arrivalPort":"SYD",
    "departureTime":"2020-06-12T09:30:23Z",
    "arrivalTime":"2020-06-13T14:25:23Z"
}

{
    "flightNumber":"QF400",
    "airlineCode":"QF",
    "departurePort":"ADL",
    "arrivalPort":"SYD",
    "departureTime":"2020-06-12T09:30:23Z",
    "arrivalTime":"2020-06-12T11:30:23Z"
}

{
    "flightNumber":"QF401",
    "airlineCode":"QF",
    "departurePort":"MEL",
    "arrivalPort":"SYD",
    "departureTime":"2020-06-12T09:30:23Z",
    "arrivalTime":"2020-06-12T10:25:23Z"
}

{
    "flightNumber":"AA111",
    "airlineCode":"CX",
    "departurePort":"ZWA",
    "arrivalPort":"SYD",
    "departureTime":"2020-06-13T11:30:23Z",
    "arrivalTime":"2020-06-14T14:45:23Z"
}

{
    "flightNumber":"AA222",
    "airlineCode":"CX",
    "departurePort":"ZWS",
    "arrivalPort":"MEL",
    "departureTime":"2020-06-15T13:30:23Z",
    "arrivalTime":"2020-06-16T14:25:23Z"
}

To view the posted data:

1. Import the following cURL statement:

curl --location --request GET 'http://localhost:8080/flight' \

2. Press Send.

To retrieve a list of flights by airline code:

1. import the following cURL statement:

curl --location --request GET 'http://localhost:8080/flight/QF' \
--header 'Content-Type: application/json' \

2. Press Send.

To search for a different airline code:

1. Change 'QF' to be a different airline code, such as CX.
2. Press Send.

Production Environment

This solution could be run in a production environment such as AWS.
An AWS Elastic Beanstalk instance could be implemented that would provide instances of S3 and EC2 to support the Web Service in Spring Boot.