jonathanmunamire/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.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Recipe App

The Recipe App keeps track of all your recipes, ingredients, and inventory. It allows 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 allows you to make them public so anyone can access them

🛠 Built With

The Recipe App was built with:

- Ruby On Rails
- PostgreSQL

Tech Stack

Client

Server

Database

Key Features

• Add posts
• Add comments
• Display details

💻 Getting Started

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

Prerequisites

In order to run this project you need:

To run this project, you'll need to install:

- Ruby 2.7.0 or later
- Rails 6.0 or later
- PostgreSQL

Installation

Install this project with:

    Clone this repository to your desired folder:

`git@github.com:jonathanmunamire/Recipe-App.git`

cd recipe-app

    Install the required gems:

bundle install

    Set up the database:

rails db:create

rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

bundle exec rspec

Deployment

You can deploy this project using:

  Not yet deployed

(back to top)

👥 Authors

👤 Jonathan Munamire

• GitHub: @jonathanmunamire
• Twitter: @amanimunamire
• LinkedIn: Jonathan Munamire

👤 Abdullateef Bello

• GitHub: @Ibnballo1
• Twitter: @webprotekh
• LinkedIn: Abdullateef Bello

🔭 Future Features

• Add a meal planner to help users plan their weekly meals.
• Allow users to add pictures to their recipes.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

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

🙏 Acknowledgments

I would like to thank @microverse

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)