Recipe APP

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Recipe App]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Recipe App]

The Recipe App keeps track of all your recipes, ingredients, and inventory. It will allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.

🛠 Built With

Tech Stack

Client

• ROR

Server

• ROR

Database

• PostgreSQL

Key Features

• Add Foods
• Display Foods
• Add Recipe
• Display Recipe
• Add Ingredient
• Display Ingredient
• Generate Shopping list

(back to top)

🚀 Live Demo

• Live deployment link works only for one week

• Recipe

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

  Ruby version - ruby 3.1.2 
  Rails version - Rails
  Chrome Browser 
  Vscode Optional

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Miliyonayalew/recipe-app.git
  cd recipe-app

Install

Install this project with:

  Run bundle install 
  Run rails db:create
  Run rails db:migrate

Usage

To run the project, execute the following command:

  rails server or rails s 

Run tests

To run tests, run the following command:

  To Run all tests - rspec
  To Run model tests - rspec spec/models
  To Run integration tests - rspec spec/views

(back to top)

👥 Authors

👤 Miliyon Ayalew

• GitHub: @Miliyonayalew
• Twitter: @Miliyonayalew
• LinkedIn: Miliyonayalew

👤 David Tamayo

• GitHub: @IngDavidTM
• Twitter: @David5TM
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• Add Search Recipe and Food
• Add Pagination or infinite scrolling for the lists.
• Improve the UI

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank the following people for their support and guidance:

• Microverse
• Code reviewers
• Coding partners

(back to top)

📝 License

This project is MIT licensed.

(back to top)