Table of Contents

• Overview
• Tools Utilized
• Endpoints
• Setup and Things to Note
• Contributors

Overview

LoHi: An API designed to consume other APIs, find users current elevation, and adjust stored recipes to account for their altitude
Built in conjunction with our Frontend team as part of our Turing Capstone project
Checkout the Frontend Repo and Deployed Site

Framework

Languages

Tools

Gems

Development Principles

Endpoints

• All available endpoints are documented on the Endpoints wiki

Project Configuration

Basic Setup

• Fork and Clone this repo locally
• Run

  $ bundle install
  $ rails db:{create,migrate}

• Figaro is used for holding and hiding API keys for the API's listed below, so Figaro must be installed

  $ bundle exec figaro install

• This will create a file in your config folder labelled application.yml. All keys created at API sites will be stored here

API Dependecies and Setup

• This API project consumes other APIs, three to be exact
• As a result, accounts will need to be made for these API's if you want to use this project locally, or some of the endpoints and tests will fail

Mapquest

• Mapquest was used for it's location and directions endpoints, and needs a developer account for access to both a Consumer Key and a Consumer Secret
• Sign up here: https://developer.mapquest.com/
• Once you have the key and secret, you can put them in your application.yml like so:

  MAPQUEST_ACCESS_KEY: YourMapquestConsumerKey
  MAPQUEST_SECRET: YourMapquestConsumerSecret

Open Weather

• Open Weather was used for it's One Call API endpoint, used to for detailed forecasts for a given location, and needs a single API key
• Sign up here: https://openweathermap.org/api
• Once you have the key, you can put it in your application.yml like so:

  OPEN_WEATHER_ACCESS_KEY: YourOpenWeatherKey

Ruby and Rails Version

$ ruby -v
ruby 2.7.2p137 (2020-10-01 revision 5445e04352) [x86_64-darwin20]
$ rails -v
Rails 5.2.6

How to run the test suite:

$ bundle exec rspec -fd

Local Deployment, for testing:

$ rails s

• From here you may access the endpoints from a utility like Postman, neccesary for the post endpoints

Schema Design

Contributors

Joana Brito

• Github: Joana Brito
• LinkedIn: Joana Brito

Jacob Martinez

• Github: Jacob Martinez
• LinkedIn: Jacob Martinez

Megan McBride

• Github: Megan McBride
• LinkedIn: Megan McBride

Jacob Piland

• Github: Jacob Piland
• LinkedIn: Jacob Piland