Skip to content

uw-coding-boot-camp-group-7/Trails

Repository files navigation

Trails by Compass Crew

Getting outside and enjoying the outdoors is somthing most everyon loves. There are many reasons to head out to the woods, unplug from all of the technology of our daily lives and recharge. Trails is your passport to the outdoors no matter where you go around the globe...yes, around the globe.

Trails helps you find the top hikes in many major cities around the world. And with your Trails Passport, you can keep track of hikes you'd like to on and the ones that you've completed.

Don't want to head out alone? With Trail Buddies, you can join an Adventure Group or create your own. So, stop waiting and go find your perfect adventure.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

  1. Clone or Fork and then clone a copy of this repo onto your local machine with 'git clone < repo url >'
  2. Download all dependancies with 'npm i'
  3. Create a MySQL database and update the config.json file with your database name.
  4. In your console navigate to the root folder of the project and enter 'node server.js' to launch the app.

Prerequisites

What things you need to install the software and how to install them. At minimum you'll need:

  1. Express
npm install express
  1. Node Install Node
  2. MySQL2
npm install mysql2

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

Contributing

If you'd like to contribute, please feel free to reach out to any of the original author.

Versioning

We use GitHub for versioning. For the versions available, see the tags on this repository.

Authors

  • Naomi Woodruff SDE: Designed and engineered the pages for the app. Provided all the great aesthetics that provide this app with its sharp, clean and polished feel.
  • Joonwoo Choi SDE: Engineered the controller pieces of the application and middleware for the application to move data from the modle to the view. Also worked on the routing pieces.
  • Josh Manuel SDE/Tech Lead: Engineereed the model, api calls, search, and routing for the app. Also provided support to other members of the team.
  • Mario Rodriguez TPM/Tech Lead: Provided team with a structured approach to tackling this project by helping define MVP, creating and assigning tasks. Also provided workflow setups with continous integration utilizing Heroku.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
  • Icons from Noun Project created by Chanut is Industries AND Stan Diers, HK