Git Product home page Git Product logo

bike-transit-planner's Introduction

Bike and Transit Route Planner

Contributors

Paige Williams

Netlify Status

Description

A web application that helps people in Portland plan their multi-modal trips. The user is able to enter their start and end point, and how many miles they would like to bike. After entering their search, the user can see routes on a map that fit thier criteria. In future iterations I would like to add user authentication and have the user be able to save their search results. I would also like to add metrics on how many miles they biked and the carbon footprint of their route.

Table of Contents

  1. MVP
  2. Further Exploration
  3. Plan
  4. Component Tree
  5. Wireframes
  6. Setup on OSX
  7. Technologies Used
  8. Configuration/dependencies
  9. MIT License

Minimum Viable Prototype (MVP)

  • The user can enter a starting point and an ending point
  • The user can enter how many miles they would like to bike
  • The user can see a list of possible routes to take to get from their starting point to the end point
  • The routes will be displayed in a map

Further Exploration

  • The user can create an account and save their routes
  • Include real time stop information so the user can see when the bus is arriving at the stops on their route
  • The user can rate their routes
  • Possible analysis on the routes, such charts showing their miles biked or carbon emmissions saved from taking transit and biking

Plan

View the plan here.

Component Tree

alt-text

Wireframe

alt-text

Technology Used

Setup

  • Install Node.js
  • Clone this project with git clone https://github.com/paigewilliams/bike-transit-planner
  • Navigate to the root directory of the project with cd bike-transit-planner
  • Create a .env file in the root of the directory
  • Generate a Mapbox access token
  • Save your access token as API_KEY in the .env file
  • Generate a Google Maps geocoder access token
  • Save your access token as GOOGLE_KEY in the .env file
  • Run npm install to install dependencies
  • Run npm run start to build and serve the project
  • View the project in any browser at http://localhost:8080/

Support and contact details

Paige Williams: [email protected]

License

This software is licensed under the MIT license.

Copyright (c) 2018 Paige Williams

bike-transit-planner's People

Contributors

paigewilliams avatar

Stargazers

 avatar

Watchers

James Cloos avatar

Forkers

skillitzimberg

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.