Pokémon App

• You can find a video walkthrough for setting up the initial API call here
• You can find a video walkthrough for exposing an endpoint here

Table of Contents

• What it does
• How to Install
• Dependencies
• Learning Goals
• Licenses
• Contact

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 [email protected]: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.

• Docker - Working with Docker

Using Docker

# Start the containers using Docker compose
docker-compose build
docker-compose run app rails db:create db:migrate
docker-compose up

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 3.2.2
• Rails 6.1.4

Contact

Sage Freeman-Gonzales: Email, GitHub