FLYBOY.TRAVEL

Here's our Official Documentation!
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

If you love travelling, you’ll know planning for a memorable trip is the worst part.

WE created this travel app to deal with that headache. Flyboy allows you to plan a trip’s itinerary with Yelp’s API to recommend top-rated spots and the booking.com API for the best accommodation deals. Plan last minute or plan in advance, this was designed to build you a full trip itinerary plan for a seamless unforgettable experience.

This project puts together all the learnings throughout 6 months of coding.

Built With

Getting Started

Front End Installation

Go into the frontend folder

npm -i

Install all the dependencies listed in the package.json. When you run this command, npm will look at the dependencies and devDependencies

npm start

Launches the browser and waits for server interaction to load Create React App

Go into .env

REACT_APP_API_SERVER_URL=http://localhost:3002
REACT_APP_AUTH0_DOMAIN=your auth0 domain
REACT_APP_AUTH0_CLIENT_ID=your client data
REACT_APP_AUTH0_CALLBACK_URL=http://localhost:3002/callback

Back End Installtion

Go into the backend folder

npm -i

Install all the dependencies listed in the package.json. When you run this command, npm will look at the dependencies and devDependencies

Setup

1. Create the .env by using .env.example as a reference: cp .env.example .env
2. Update the .env file with your correct local information

• username: yourname
• password: yourpassword
• database: flyboy

3. Install dependencies: npm i
4. Fix to binaries for sass: npm rebuild node-sass
5. Reset database: npm run db:reset

• Check the db folder to see what gets created and seeded in the SDB

7. Run the server: npm run local

• Note: nodemon is used, so you should not have to restart your server

8. Visit http://localhost:8080/ and it will serve the react file.

Warnings & Tips

• Do not edit the layout.css file directly, it is auto-generated by layout.scss.
• Split routes into their own resource-based file names, as demonstrated with users.js and widgets.js.
• Split database schema (table definitions) and seeds (inserts) into separate files, one per table. See db folder for pre-populated examples.
• Use helper functions to run your SQL queries and clean up any data coming back from the database. See db/queries for pre-populated examples.
• Use the npm run db:reset command each time there is a change to the database schema or seeds.
  • It runs through each of the files, in order, and executes them against the database.
  • Note: you will lose all newly created (test) data each time this is run, since the schema files will tend to DROP the tables and recreate them.

Dependencies

• Node 10.x or above
• NPM 5.x or above
• PG 6.x

API FLOW

• express server creates routes -cors allows communcation between server and browser

Features

AUTH0

Auth0 is to authenticate users and push to our postgres database

FORMIK

Formik is used to create forms and handle data transmission

Saved searches

Once the search is complete, you can view your interary and save them!