aetzion1/sweater-weather

Sweater Weather

Sweater Weather is an application that allows users to plan road trips, mainly by providing access to the current weather as well as the forecasted weather at their destination. This is the back-end component of a service-oriented architecture. The front-end communicates with this back-end via an API. This repository exposes that API to meet the front-end requirements.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Learning Goals
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Sweater Weather is an application that allows users to plan road trips, mainly by providing access to the current weather as well as the forecasted weather at their destination. This is the back-end component of the service-oriented architecture. The front-end communicates with this back-end via an API. This repository exposes that API to meet the front-end requirements.

Learning Goals

This back-end application was created with the following learning goals in mind:

• Expose an API that aggregates data from multiple external APIs
• Expose an API that requires an authentication token
• Expose an API for CRUD functionality
• Determine completion criteria based on the needs of other developers
• Research, select, and consume an API based on your needs as a developer

Built With

• Ruby on Rails
  • Ruby 2.4.1
  • Rails 5.2.3
• RSpec (version 3.8.2)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• ruby 2.4.1
• rails 5.2.3
• rspec 3.8.2

Setup

1. Clone the repo

   git clone https://github.com/aetzion1/sweater-weather.git

2. Install gems

   bundle install

3. Create and migrate database rails db:create rails db:migrate
4. Register for API keys and add to application.yml

• MapQuestGeocoding Used to get coordinates based on search criteria
• OpenWeatherOneCall Used to get forecast data based on specific coordinates
• Unsplash Used to pull images based on location query paramters

Gems worth researchin

• Faraday
• Fast JSON API
• Webmock
• VCR
• Figaro

Usage

Endpoints

The endpoints utilized to design this applciation can be found here

The Postman service can be used to test the above endpoints locally. You can import the following pre-built_collection directly into Postman.

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

License

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

Contact

Adam Etzion - GitHub - LinkedIn

Project Link: github.com/aetzion1/sweater-weather

Acknowledgements

• MapQuest
• OpenWeather
• Unsplash