Skip to content

Mobile web application designed to provide real-time information about the NYU shuttle bus service.

License

Notifications You must be signed in to change notification settings

r8btx/NYU-Shuttle

 
 

Repository files navigation

NYU Shuttle App

Project Description

The NYU Shuttle App is a mobile application designed to provide real-time information about the NYU shuttle bus service. It is a convenient tool for NYU students, faculty, and staff to track shuttle bus locations, plan routes, and receive updates on shuttle schedules. The primary goal of this project is to enhance the overall commuting experience for the NYU community by making transportation more efficient and accessible.

Product Vision Statement

Recognizing the limitations in NYU's existing shuttle app, primarily concerning its user interface, we want to create a better mobile-friendly application with shuttle information that is easy to access and understand.

Team Members

History and Contribution Guidelines

The NYU Shuttle App project originated from a group of NYU students who recognized the need for an improved shuttle service experience, as many students and faculty had expressed frustrations with the existing web application. If you'd like to contribute to this project, please read our CONTRIBUTING.md document for guidelines on how to get involved.

Access deployed aplication:

  • Navigate to 138.197.74.172:4000 in your browser to check out our deployed app!

Building and Testing

Fork the repo and clone it locally. Then:

  1. cd to front-end and back-end

  2. Install Dependencies:

    npm install
    
  3. Put Google Maps API key at utils/MapUtility.js (const API_KEY)

  4. In the front end folder, put the following keys in a .env file:

    • REACT_APP_MAP_API_KEY (please, reach out to us for the exact key)
    • REACT_APP_BACKEND==http://localhost:4000
  5. In the back end folder, put the following keys in a .env file:

    • MONGODB_URI= (please, reach out to us for the exact key)
    • FRONT_END_DOMAIN=http://localhost:3000
    • EXPRESS_APP_MAP_API_KEY (please, reach out to us for the exact key)
  6. To run backend tests cd to the backend folder and run:

    npm test
    
  7. Run frontend and backend

    npm start
    

Additional Resources

Contact Us

If you have any questions, feedback, or suggestions, please feel free to open an issue or reach out to any of the core team members mentioned above. We appreciate your support and look forward to improving the NYU shuttle experience together!

About

Mobile web application designed to provide real-time information about the NYU shuttle bus service.

Resources

License

Stars

Watchers

Forks

Languages

  • JavaScript 92.4%
  • CSS 6.2%
  • Other 1.4%