Hello World

1. Software Overview
2. Requirements and Prerequisites
   1. Compatible Operating Systems
   2. Supported Web Browsers
   3. System Requirements
   4. Library Requirements
      1. Frontend
      2. Backend
   5. Key Requirements
      1. Firebase Key
      2. Amadeus API Key
3. Installation and Development
   1. Development
4. Design Diagrams
   1. High Level Systems Diagram
   2. Use Case Diagram
   3. Frontend Webpages

---

Preview

Software Overview

HelloWorld is a web application that retrieves the cheapest flight option based on users’ desired flight characteristics. The current supported list of flight characteristics include:

• origin and destination
• one-way vs. round-trip
• number of travelers
• cabin class
• departure date and return date.

* Our software allows users to enter multiple origin locations and destination locations. Our software provides users the option to bundle various groups together in a preset and tie those customized presets to their account.

Search feature allows users to toggle various origin and destination locations manually, or autofill the flight search interface with the locations presets tied to their account for ease of use. Based on the information the user provides, our software makes calls to the Amadeus Flight API and sorts the flights returned. We sort from lowest to highest price per flight duration. Each itinerary results reflects the users' inputs in the optimal sorting order (metrics is price/flight duration). The current supported list of each itinerary result include:

• total travel time
• layover information (duration, time stamps)
• airline carriers

With our software, users are able to sift through results returned to them and see flight numbers for each flight to allow them to lookup that flight on a flight purchasing website at ease.

---

Requirements and Prerequisites

Compatible Operating Systems

Most modern operating systems (Windows, MacOS, Linux, etc.) with web browser

Supported Web Browsers

All modern browsers (Edge, Firefox, Chrome, Safari, etc.)

System Requirements

• Server environment: Node.js
• Package manager: npm (preferred and included when you install Node)
• Version control: git

Library Requirements

All dependencies with their versions are listed in the metadata/configuration files in our project (backend dependencies here, frontend dependencies here). Important requirements are listed below:

Frontend

• Material UI
• React
• React Router DOM
• Firebase
• Dayjs

Backend

• Amadeus
• Express
• GraphQL
• Firebase SDK for Cloud Functions

Key Requirements

To ensure the proper functionality of this project, you must configure the following keys:

Firebase Key

For Firestore and Firebase Authentication, you need to set up your Firebase project and obtain your unique Firebase key. Follow these steps:

1. Go to the Firebase Console.
2. Create a new project or select an existing one.
3. Navigate to the project settings and find your Web API Key.
4. Place this key in your frontend/Firebase folder.

Amadeus API Key

This project uses the Amadeus API to search for flights. You will need to obtain your API key by following these steps:

1. Sign up for an account at Amadeus for Developers.
2. Create a new application within your dashboard to receive your API credentials.
3. You'll receive an API Key and API Secret—both of which you'll need to use the Amadeus services.
4. Add the API Key and Secret to your backend/Amadeus folder.

---

Installation and Development

Development

First, ensure your operating system, and web browser requirements are met.

Second, install Node.js and npm with the appropriate installer to your OS. Development of this project is done using Node v18.14.1 and npm v9.3.1

Third, navigate to your directory of choice. Clone the repo and navigate there with

git clone https://github.com/tvay11/helloworld.git && cd helloworld

Within the helloworld directory, navigate to the frontend folder and install its dependencies locally ¹

cd frontend && npm install

Return to project root in helloworld and navigate to backend folder and install its dependencies locally ¹

cd ../backend/server/ && npm install

Preferred Way to Compile

Once within HelloWorld folder...

• To run frontend, cd frontend and then run npm start
• To run backend server, cd backend/server and then run npm run dev

---

Design Diagram

High Level Systems Diagram (View in Light Mode)

   %%{ init : { "theme" : "forest"}}%%
   graph LR;
   Frontend & DB[(Firestore)] & API--> Server[Server];
   Server--> Frontend & DB & API;
    Firebase[(Firebase auth )] --> DB;
    DB --> Firebase;

Loading

Use Case Diagram

   %%{ init : { "theme" : "forest", "graph" : { "curve" : "linear" }}}%%
   graph TD
   u{User} --takes action--> FlightSearch & Signup & Login & SaveFlightInfo
  
   FlightSearch --searches flights---> Server(NodeJS Server)
   Server --retrieves info---> API(Amadeus API)
   subgraph flight search
   FlightSearch
   API
   end


   SaveFlightInfo --saves flight info ---> Server --retrieves info ---> DB[(Firestore)]
   subgraph save
   SaveFlightInfo
   DB
   end
  
   Signup --creates a login ---> Server --authenticates user ---> FB[(Firebase)]
  
   subgraph authentication
subgraph signup
   Signup
   end
   subgraph login
   Login
   end
   FB
   end


   Login --sends a login request ---> Server
  
   Server --returns info ----> UI(User Interface)
  

Loading

Frontend Webpages

   %%{ init : { "theme" : "forest", "graph" : { "curve" : "linear" }}}%%
   graph TD
   Homepage --create account--> Creation(Account Creation Page)
   Homepage --login to account--> Login(Account Login Page)
   Creation -- login to newly created account --> Login
   Homepage -- enter desired flight info --> Results(Results Entries)
  

Loading

---

Footnotes

1. It is recommended to install dependencies locally to avoid version incompatibility with your other projects. ↩ ↩²