fieldceleste / capstone-intinerizeMe

This is a final capstone project for Epicodus that showcases skills using React, Firebase, and Javascript.

By: Celeste Field

July 13, 2020

• About the Project
  • Description
  • Known Bugs
• Scope
  • User Stories
  • Minimal Viable Product
  • Product Roadmap
  • Specs
  • Component Diagram
  • Screenshots
• Getting Started
  • Prerequisites
  • Installation
  • Deployed website
• Auxiliary
  • Technology
  • Contributors
  • Contact
  • License

This dynamic site is intended for the traveler who can never decide what to do with their day. It allows the user to enter in their travel dates and location and be able to get a curated day by day trip plan using the Triposo API. They are able to login and add different trips to their list and save them to the database. They will be able to see each location on a Google map to know exactly where they are going each day.

• Project Mission & Summary

  • Welcome to ItinerizeMe, where you can travel worry free. We at ItinerizeMe want your travel experience to be as easy as clicking a button. This mobile friendly application allows a user to quickly figure out their daily travel plans.

• Timeline

  • Week 1: Add in extensive Readme, start researching API's and start to build components.
  • Week 2: Start coding in components, retrieve data from APIS, and add in authentication and authorization.
  • Week 3: Add in styling to page, finish Readme, and finalize components if not complete.

• Goals

  • Authorization and Authentication implemented for the user to login/sign-out to have the ability to add, modify and delete cities in their queue.

  • Connect to Triposo API to retrieve travel data about places to see, eat and shop.

  • Connect to Uber/Lyft API to get transportation to locations in itinerary.

  • Connect to TransitFeed API to get transportation to locations in itinerary.

  • Keep trips in separate groups in Firebase database and have ability to add in other trips with various cities.

  • Create mobile friendly version using React Native.

No known bugs at this time.

Main users are travelers abroad who are unfamiliar with the cities on their agenda, students who are new to their campus town, locals who just want to explore their own city and business travelers who only have a short amount of time to explore.

• The application will allow the user to create an account, login or logout.

• The application will allow the user to enter in their trip details with time of arrival/ departure, dates of travel, and city location.

• The application will allow the user to click on a place of interest or food location and see information about it.

• The application will allow the user to see the point of interest on the map.

• The application will allow the user to click on different days and see a completely new itinerary.

• The application will adjust things to do on the first and last day based on the time of departure and arrival.

• The application will save their city to the database so the user can add more locations to one trip.

• Website is in portfolio ready state, with designs working as intended.

• Click functions work as intended without bugs.

• CRUD functionality, so users can add trips, view trips, delete trips and modify them.

• Authorization and Authentication are fully functional.

Spec	Input	Output
enter in specs when complete

• Download a code editor, such as Visual Code studio, Atom, Sublime Text.

• Install Node.js Download & Install Node.js

• Install React Tools by running npm install react-tools

• Apply for API on Triposo and get an API key.

1. Open Terminal (macOS) or PowerShell (Windows)

2. To download the project Directory to your desktop enter the following commands:

cd Desktop

git clone https://github.com/fieldceleste/capstone-intinerizeMe.git

cd capstone-intinerizeMe

3. To view the downloaded files, open them in a text editor or IDE of your choice.

• if you have VSCode for example, when your terminal is within the main project Directory you can open all of the files with the command:

code .

5. Download node and node package manager if they are not already installed on your device. You can find further instructions here.

6. Run npm install in your terminal to download the necessary dependencies, plugins, and modules.

npm install

6. When ready for production mode run this command in order to optimize the best preformance:

npm run build

7. The command npm run start will build and open the compiled code in a browser of your choice using a local host.

npm run start

• Use can find deployed website by the provided link here

• React

  • React Bootstrap
  • React Redux
  • React Router
  • Google Map React
  • Mobx React

• JavaScript

• JSON

• Firebase

• CSS/SASS

• Bootstrap

• Markdown

• Redux

• Triposo API

• Git/Github

• Mobx

• Moment

Celeste Field	You?
🔥

• Questions or concerns? Please contact [e-mail]

• Licensed under MIT.

• Copyright (c) 2020 Celeste Field