/pokemon_app

App that consumes pokemon api and renders pokemon

Primary LanguageRuby

Pokémon App

You can find a video walkthrough for setting up the initial API call here

Table of Contents

What it does

This app will be used to get an introduction to API consumption and refactoring in rails. This project follows Service-Oriented Architecture (SOA) that provides users with Pokemon information based on search parameters that the user provides.

  • Fork and clone this repository. Run bundle install.

  • We will be consuming this Pokémon API.

  • Download Postman here. We will be using Postman to call our API.

How to Install

For usage on your local machine follow the instructions listed below:

git clone git@github.com:SageOfCode/pokemon_app.git
cd pokemon_app
bundle install
rake db:{create,migrate}
firgaro install
rails server
visit localhost:3000 in your web browser

Dependencies

  • This app uses Rails version 5.2.4.4

  • We use the Faraday Gem to make calls to our API service.

  • We use the Figaro Gem to keep confidential information like API keys secure.

  • The SimpleCov gem was used to ensure that we covered 100% of our code with unit testing.

Learning Goals

  • Consume external APIs

  • Refactor code for better code for improved organization/readability

  • Utilize workflow: small commits, descriptive pull requests and code review

  • Write thorough and understandable documentation

Licenses

  • Ruby 2.5.3
  • Rails 5.2.4.4

Contact

Sage Freeman-Gonzales: LinkedIn Email, GitHub