Lunch and Learn

An api for users to discover recipes, how to cook them, and save their favorites using an api key.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

This is an api based application that allows users to discover new foods, how to cook them and learn a little bit about a different culture.

(back to top)

Built With

• 
• 
• 
• 
• 
• Readme Template

(back to top)

Getting Started

1. Fork or clone a copy of this repo, then run the following commands from the project directory in your terminal:

   bundle install
   rails db:create{drop,create,migrate,seed}

Prerequisites

• Ruby 3.2.2
• Rails 7.0.6
• Postgresql 14

Installation

1. Get a free API Key and/or Application Keys at:

   1. Edamam
   2. Youtube
   3. Unsplash
   4. API Ninjas

2. Clone the repo

   git clone https://github.com/garrettgregor/lunch_and_learn.git

3. Install NPM packages

   bundle install

4. Enter your Keys in application.yml

   EDAMAM_APP_KEY: <edamam_app_key>
   EDAMAM_APP_ID: <edamam_app_id>
   YOUTUBE_API_KEY: <youtube_key>
   UNSPLASH_API_KEY: <unsplash_authorization_token>
   API_NINJA_API_KEY: <api_ninja_x_api_key>

(back to top)

Usage

Users can:

• Register and Login
• Discover New Recipes from Random Countries
• Save Favorite Recipes

(back to top)

Roadmap

• Validate countries using the Rest Countries API
• Add an endpoint to delete a favorite
• Utilize caching or background workers to optimize api calls
  • Deploy on Render
• Build a front end using React

See the open issues for a full list of proposed features (and known issues).

(back to top)

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!

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

(back to top)

License

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

(back to top)

Contact

Your Name - @garrettgregor - [email protected]

Project Link: https://github.com/garrettgregor/lunch_and_learn

(back to top)

Acknowledgments

• Mike Dao
• Erin Pintozzi

(back to top)