Skip to content

hey24/footsteps

Repository files navigation

Footsteps - Connecting Hikers One Step at a time 🦶

Table of Contents

  1. About
  2. The App In Use
  3. How to Install and Run Footsteps
  4. Credits

About

Welcome to Footsteps, a mobile app designed to connect hikers and make planning your next hiking adventure easy and fun.

Footsteps allows users to create and join hiking groups, plot custom routes, and chat with other hikers to communicate logistics, share tips, and make friends.

With Footsteps, you can easily search for hikes in your area, or add your own for others to discover. Whether you're a seasoned hiker or just starting out, Footsteps has everything you need to make coordinating outings simple.

Our goal at Footsteps is to build a community of like-minded individuals who share a passion for hiking and the outdoors. We believe that helping people connect is the best way to make hiking more accessible and enjoyable for everyone.

Thank you for choosing Footsteps and happy hiking!

The App in Use

  1. Search for where you want to go hiking and view the Hikes in your area, or create your own.

Footsteps-gif-1
2. If you're the owner of a Hike you can plot and set a route, which will be visible to everyone included in the Hike. The distance will also be updated in accordance with your custom route!

footsteps-route-plot-gif

How to Install and Run Footsteps

N.B All $ refer to terminal commands

  1. Make sure you have yarn and rails intalled on your machine by checking the current version:
$ yarn -v
$ rails --version

If yarn is not installed use the following command to install it:

$ npm install --global yarn

Follow the same process if you do not have rails installed:

$ gem install rails

If this has not worked, please refer to the docs

  1. Install all the dependencies - Need to install the ruby gems from the gemfile and the dependencies from package.json
$ bundle install && yarn install
  1. To create the database and utilise our current seed data, use the following command:
$ rails db:create db:migrate db:seed
  1. You must generate your own API keys for Cloudinary and Mapbox in order to use Footsteps
    Create a .env file and paste in your Cloudinary key and Mapbox key

  2. Launch a rails server and yarn

$ bin/dev
  1. See the app, up and running on your localhost!

Credits

This project couldn't have been made without our amazing team ❤️

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •