Visit https://www.dayvoyage.com

• [Steven Tran] (https://github.com/steventran06)
• [Vivian Chen] (https://github.com/vichen)
• [Tor Sinclair] (https://github.com/torsinclair)
• [Michael Rico] (https://github.com/mrmrico)

1. Why Day Voyage
2. Up and Running
3. Requirements
4. Development
5. [Depolyement] (#deployment)
6. Application Architecture
7. Unstacking the Stack
8. API's
9. Challenges
10. [Roadmap] (#roadmap)
11. Contributing

For locals and travelers to build and share custom plans of fun things to do around town or anywhere you go.

On a budget? Day Voyage helps tailor your plans to meet a budget of any size.

• Install dependencies
• Export environment
• Start server
• Please visit API repo for instructions on setting up api for data layer.

npm install
npm start

You are now running locally on localhost:3000

• React
• Redux
• Node 5+
• Webpack 1.11.0
• Postgres 9.5.2.0
• Nodal 0.1.0

Please see this repo for information about requirments and set up for the API driving our data layer.

To build webpack and generate a bundle: From within the root directory:s

npm start

DayVoyage is deployed on AWS, taking advantage of their Elastic Compute Cloud (EC2) that makes web-scale convenient. For those not familiar with AWS, AWS provides a simple web service interface making it relatively easy to configure capacity.

To leverage off the AWS infrastructure DayVoyage chose to deploy its Express Server within an EC2 instance. The Express Server handles all api requests from clients and interfaces with Nodal Server.

Nodal Server, in turn, is reponsible for all API requests to the database and we have chosen to deploy the Nodal Server as its own EC2 instance also.

The Postgres SQL Database has been setup witin AWS Managed Relational Database Service. The purpose for deploying the database within its own environment is to extend AWS managed service that makes it easy to operate and scale a relational database in the cloud. Amazon RDS automatically patches the database software and backs up your database, storing the backups for a user-defined retention period.

Deployment runs Screen. screen ensures process runs even when terminal exits screen -r enters same session on re-login.

DayVoyage is tested using Mocha and Chai.

To generate docs:

npm start doc

Refer to http://en.blog.koba04.com/2015/06/28/esdoc-documentation-for-react-and-es6/ for how to write in-line documentation.

Day Voyage is a Single Page Application built with:

• React (drives user driven client side interface)
• Redux (application state management)
• React Router and Redux Router (client side routing)

• Views are created using modular and reusable components built in React/JSX.
• React components implement one-way reactive data flow to immediately rerender views upon changes.

• Day Voyage uses the React Router library for dynamic route matching to keep our UI in sync with the URL.
• URL paths are synced seamlessly with React view components and allows for smooth transition between page routes.

• Unidirectional data-flow normalizes data and provides predictability
• Manages states and acts as a single source of truth for data shared by components throughout the application
• Utilized in conjunction with local states to preserve modularity
• Snapshot of application state tree:
  • activities: results from Yelp API call
  • auth: stores web tokens and user information
  • dashboard: stores user created plans (itineraries)
  • data: loading information and miscellaneous items (i.e. budget)
  • dbactivities: results from database api call for activities
  • directions: stores map coordinates of activities
  • planBuilder: temporary list of activities that the user is creating before saving the the database
  • router: keeps track of react router history and location change

• Day Voyage utilizes Node.js for its extensive package ecosystem through npm, including React and other libraries.

• Day Voyage is served using Express, which provides server-side routing and an enviornment for executing API calls to the database and external APIs.
• Utilizes middleware such as body-parser for requests and webpack-dev-middleware to serve our Webpack assets.

The data powering our app

• Built with Nodal and Postgres
• See linked repo for endpoints and schemas
• Postgres
  • Our solution for the relational nature of the data
  • Recommended to use Postgres.app for mac users
• Nodal
  • Our server interfacing with the Postgres instance
  • Separating our API from the application server decouples concerns of the cient and data

• Day Voyage utilizes the Yelp Search API to supplement user-generated activities with local establishments based on your search query in the city of your choosing.

• Google Maps - Implemented using the React-Google-Maps library. Day Voyage generates all search points on the map and creates routes between activities in a plan based on the order of activities set.
• Google Geocoding - When geolocation search is activated, Google Geocoding is used to translate the coordinates from latitude/longitude to a city name, so it can be implemented as a location query for our database and the Yelp Search API.
• Google Distance Matrix - allows for searches based on geolocation. All activities in the application include the distance from the user's location in miles.

Our team sailed through on calm seas!

See CONTRIBUTING.md for contribution guidelines.