Trails-N-Brews_FE

Trails N Brews, FE

A guide to lead hikers to "watering holes"
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About The Project
  • Learning Goals
  • Built With
  • Roadmap
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Endpoints
• Contributing
• Developers
• Project Managers-Instructors

About The Project

Trails N' Brews (TnB) is a web app seeking to answer one of life's greatest needs for the Colorado hiker. Whether it be a 1 mile trail along the front range or an expedition to the summit of one this great state's many 14ers all hikers want to know where the nearest brewery is to celebrate and wind down from their achievement. TnB is designed with service oriented architecture.

This repository holds the front end code for TnB, the backend repo is located here

(back to top)

Built With

(back to top)

Learning Goals

• Project management and organization
• Agile workflows
• Improve individual and group communication skills
• Microservice integration and implementation
• Service integration and implementation
• OAuth utilization
• Efficient API consumption

(back to top)

Getting Started

Prerequisites

• Ruby 2.7.4
• Rails 5.2.8

Installation

Below are instructions for forking and cloning this repo

1. Clone the repo

   git clone [email protected]:TrailsNBrews/Trails-N-Brews_FE.git

2. Install gems

   bundle install

3. Setup the database

   rails db:{create,migrate}

4. Run RSpec tests

   bundle exec rspec

(back to top)

Usage

• Visit https://trails-n-brews.herokuapp.com/ to arrive at the landing page:

  • Click the 'Sign in/Sign up with Google' button (a Google account is required to use this app)
  • Log in to a Google account
  • If login is successful, the page will redirect to a user dashboard

• Dashboard:

  • From the user dashboard, a user can find a trail, find a brewery, or list their accomplishments

• Find a trail:

  • Click the Find Trail button, and enter a search for a trail
  • The top three trails are displayed

• View a trail:

  • Click on the desired trail
  • A description of the trail will display along with its difficulty rating and location
  • A location of the trailhead is provided by utilizing Google Maps API

• Find a brewery:

  • Click the Find Brewery button, and enter a search for a brewery
  • The top five breweries are displayed

• View a brewery:

  • Click on the desired brewery
  • The brewery's pertinent information will display
  • A location of the brewery is provided by utilizing Google Maps API

(back to top)

Endpoints

• Root directory: 'https://trails-n-brews.herokuapp.com'

(back to top)

Developers

Brandon Gray
Github: bGray88

Christian McCabe
Github: cemccabe

Kyle Ledin
Github: Kledin85

Leo Banos Garcia
Github: banosl

Max MacGillivray
Github: MoxieMax

Sergio Azcona
Github: Sergio-Azcona

Project Links:
Organization Link
Backend Link
Frontend Link

Project Managers/Instructors

1. Meg Stang
2. Mike Dao

(back to top)