This is my submission for the 2023 CSIT Software Engineering Mini challenge. Each folder contains its own README as a guide. The Python folder was used as the submission.
- CSIT-SE-MINI-CHALLENGE
- Table Of Contents
To run the the REST API on your local machine, follow these steps:
$ sudo apt update
$ sudo apt -y install make
$ make -version
Make
is a little bit of a hassle to install on Windows, but is definitely worth it.
Windows Search > Windows Powershell > Right Click > Run as Administrator
If Get-ExecutionPolicy
returns Restricted
, run the following command.
$ Set-ExecutionPolicy AllSigned
If it is already unrestricted, then you can skip this step.
$ Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
$ choco install make
$ make -version
$ Set-ExecutionPolicy Restricted
Ensure that the above steps have been done before proceeding with deployment.
Fill in the necessary credentials in the .env
and {language}\.env
file. The main .env file contains env variables used in the docker compose while the in directory .env contains env variables for the backend container.
$ make build
$ make up
$ make down
-
Description: Get a list of return flights at the cheapest price, given the destination city, departure date, and arrival date.
{ "departureDate":"<departuredate>", "returnDate":"<returndate>", "destination":"<destination>", }
[ { "City": "Frankfurt", "Departure Date": "2023-12-10", "Departure Airline": "US Airways", "Departure Price": 1766, "Return Date": "2023-12-16", "Return Airline": "US Airways", "Return Price": 716 } ]
{ "error":"All parameters (departureDate, returnDate, destination) must be provided" }
-
Description: Get a list of hotels providing the cheapest price, given the destination city, check-in date, and check-out date.
{ "checkInDate": "<checkInDate>", "checkOutDate": "<checkOutDate>", "destination": "<destination>" }
[ { "City": "Frankfurt", "Check In Date": "2023-12-10", "Check Out Date": "2023-12-16", "Hotel": "Hotel J", "Price": 2959 } ]
{"error":"All parameters (checkInDate, checkOutDate, destination) must be provided"}