Skip to content

Commit ee7c8e6

Browse files
author
Adam Back
authored
(doc) Added README with basics.
1 parent 443efad commit ee7c8e6

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# Flight-Search
22
A simple fullstack web application which accesses an outside API to search for flights.
3+
4+
## System Requirements
5+
6+
- Node.js
7+
- npm (comes with Node)
8+
- Modern browser
9+
- Internet connection
10+
11+
## Run
12+
13+
1. Clone the repository to your local machine.
14+
1. `cd Flight-Search/`
15+
1. `bash start.sh`
16+
- Installs npm packages
17+
- Starts server
18+
- Launches page on localhost:3000
19+
20+
## Todo's
21+
22+
- [ ] Currently, the input form only takes airport codes. It would be best to allow users to type cities and suggest airport codes (using the /airports endpoint).
23+
- [ ] Make price matrix clickable. Clickable dates shows only flights for that date. Clickable airlines shows only that airlines. Generally sortable flights rather than just guessing that user wants the cheapest flight.

0 commit comments

Comments
 (0)