README

Lunch and Learn

Table of Contents

• Project Overview
• Learning Goals
• Planning Documents
• Technologies and Tools
• Setup

Project Overview

Back-end portion of a Service Oriented Architecture application to search for cuisines by country, and provide opportunity to learn more about that countries culture. This app will allow users to search for recipes by country, favorite recipes, and learn more about a particular country.

Learning Goals

• 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
• Test both API consumption and exposure, making use of at least one mocking tool (VCR, Webmock, etc).

Planning Documents

Project Spec Project requirements

Technologies and Tools

Built With:

• Rails v5.2.8
• Ruby 2.7.2

Tested With:

• RSpec
• PostMan
• SimplCov
• Pry

Other Gems Used:

• Faker
• Factorybot
• Figaro
• Faraday
• Webmock
• VCR
• jsonapi-serializer

API Keys need

• Get a free API Key for EDAMAM Recipe Here
• Get a free API Key for YouTube videos at Here
• Get a free API Key for Unsplash images atHere

Setup

1. Fork and clone this repository.
2. Cd into the root directory and run code .(for Visual Studio).
3. To run this server, run rails s in the terminal and rails will start the development server. To stop the local server, use command Control + C.
4. Please use Postman to view endpoint information. url: http://localhost:3000<'END POINT HERE>

End Points

Get Recipes for a Particular Country

• GET /api/v1/recipes?country=#{country} Frontend wireframe

Get Learning Resources for a Particular Country

• GET /api/v1/learning_resources?country=#{country} Frontend wireframe

User Registration

• POST /api/v1/users Frontend wireframe

Add Favorites

• POST /api/v1/favorites Frontend wireframe

Get a User's Favorites

• GET /api/v1/favorites?api_key=jgn983hy48thw9begh98h4539h4 Frontend wireframe

Kevin Ta

LinkedIn