|
1 |
| -# reza-todd-final |
| 1 | +# R.T. Productions Travel Partner Application. [Visit us here](https://github.com/fac31/reza-todd-final) |
2 | 2 |
|
3 |
| -how to get started: |
| 3 | +<img src = 'ReadMe.jpeg' alt = 'visual of the home page for the RADAR app.'></img> |
| 4 | + |
| 5 | +## About |
| 6 | + |
| 7 | +Meet RADAR, your newest travel companion. RADAR allows you to search any location in the world and receive up-to-date live information. |
| 8 | + |
| 9 | +The project is aimed at a customer base who are travelling or looking to travel and require a holistic overview of a location so that they can pack accordingly, gain an insight, and be prepared for their visit. |
| 10 | + |
| 11 | +## Full-Stack Project |
| 12 | + |
| 13 | +A final project to display our full-stack learning over the course of our studies with Founders and Coders. HTML, CSS, JavaScript, and Express. |
| 14 | + |
| 15 | +## What we learned |
| 16 | + |
| 17 | +- How to create an appealing user interface. |
| 18 | +- Expanding knowledge in front end javascript through text rotation, pop-up information, image carousels. |
| 19 | +- Demonstrating information in a dynamic way. |
| 20 | +- Using several API's to provide a holistic application. |
| 21 | +- Realising a completed application with a functional front & back end. |
| 22 | + |
| 23 | +## If we had more time |
| 24 | + |
| 25 | +- Create a database to store locations people had previously researched. |
| 26 | +- Enable a user to be able to compare different locations. |
| 27 | + |
| 28 | +## How to install and use |
| 29 | + |
| 30 | +**How to get started:** |
4 | 31 | `git clone [email protected]:fac31/reza-todd-final.git`
|
5 | 32 |
|
6 |
| -navigate to the directory: |
| 33 | +**Navigate to the directory:** |
7 | 34 | `cd reza-todd-final`
|
8 | 35 |
|
9 |
| -create a `.env` file in the root directory and add the following: |
| 36 | +**Create a `.env` file in the root directory and add the following:** |
10 | 37 |
|
11 | 38 | `PORT=your_port_number`
|
12 | 39 |
|
13 |
| -install dependencies |
| 40 | +**Install dependencies** |
14 | 41 | `pnpm install`
|
15 | 42 |
|
16 |
| -run the app |
| 43 | +**Run the app** |
17 | 44 | `pnpm start`
|
18 | 45 |
|
19 |
| -run the app in dev mode |
| 46 | +**Run the app in dev mode** |
20 | 47 | `pnpm dev`
|
21 | 48 |
|
22 |
| -run the tests |
| 49 | +**Run the tests** |
23 | 50 | `pnpm test`
|
24 | 51 |
|
| 52 | +### Authors |
| 53 | + |
| 54 | +<a href = 'https://github.com/RGHANILOO'> |
| 55 | + <img src = 'https://avatars.githubusercontent.com/u/26300368?v=4' style="border-radius: 50%; width: 50px;"> |
| 56 | +</a> |
| 57 | + |
| 58 | +<a href = 'https://github.com/tt01924'> |
| 59 | + <img src = 'https://avatars.githubusercontent.com/u/150555214?s=400&u=c30c8b1a0f766863602ec773c8e3bbf149e14c71&v=4' style="border-radius: 50%; width: 50px;"> |
| 60 | +</a> |
| 61 | + |
0 commit comments