README

Lunch and Learn

Lunch and Learn is backend application built with Ruby on Rails. It is a student project from Turing's Backend Module 3 program. It is an API based application that allows users to search for recipes based on an searched country. From there they can learn more about the country by watching YouTube videos or finding books about said country. Users will be able to add favorites to their personal list of recipe faves. This app follows RESTful API conventions.

Learning Goals

The learning goals of this project were to

expose an API that aggregates data from multiple external APIs
expose an API that requires an authentication token
implement basic authentication
expose an API for CRUD functionality
determine completion criteria based on the needs of other developers
test both API consumption and exposure
make use of at least one mocking tool (VCR)

Setup

fork and clone repo
install gems into Gemfile: bundle install; bundle exec figaro install
set up database rails db:create
get your API keys

[https://restcountries.com/#api-endpoints-v3-all]
[https://developer.edamam.com/edamam-recipe-api]
[https://cloud.google.com/apis]
[https://unsplash.com/developers] and add keys to the application.yml file created after installing figaro

Endpoints

GET /api/v1/recipes?country=
GET /api/v1/learning_resources?country=
POST /api/v1/users
POST /api/v1/favorites
GET //api/vi/favorites?api_key= ``

Versions

Ruby 3.2.2
Rails 7.0.6

Built With

Project Requirements and Wireframes

[https://backend.turing.edu/module3/projects/lunch_and_learn/requirements]

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Repo Author

Julian Beldotti

JCBeldo / lunch_and_learn