Trail-Traffic/Trail-Traffic-App

A mobile application to check traffic at popular hiking spots

A mobile application to check traffic at popular hiking spots.


· Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
  • Installation
• Usage
• Roadmap
• Contributing
• License

About The Project

Trail Traffic was created to make outdoor activities safer and more convenient—so you can avoid the crowds at popular hiking spots. The project is currently in Beta.

Built With

• React Native
• besttime API

Installation

1. Fork the repo
2. Clone the repo

git clone https://github.com/Trail-Traffic/Trail-Traffic-App.git

3. Start server and app

npm install

npm run dev

Note: to run heatmap data, you will need to get your own access token to the besttime.app API and store all location, public, and private key variables in a file called secrets.js in the project's root directory

Usage

View five popular trails in Los Angeles and a heatmap displaying their current traffic.

To keep track of favorites, sign up with your Google account (accessed via the bottom right nav tab). Trail Traffic will keep all of your personal information confidential.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request to the path-19 staging branch

License

Distributed under the MIT License. See LICENSE for more information.