📗 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
• ❓ FAQ (OPTIONAL)
• 📝 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 Ruby on Raails

Tech Stack

• Ruby
• Ruby on Rails
• PostgreSQL

Client

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [User_Authentication_and_Authorization]
• [Food_Management]
• [Recipe_Management]
• [Public_Recipe_List]
• [General_Shopping_List]
• [Navigation_Menu]
• [Testing]

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:Outkarm/recipe-app.git

Install

Install this project with:

  cd recipe-app
  gem install

Usage

To run the project, execute the following command:

  bundle install
  rails db:create
  rails db:migrate
  rails server

Run tests

To run tests, run the following command:

   rspec

-->

(back to top)

👥 Authors

👤 John Kpordje

• GitHub: @Outkarm
• Twitter: @outkarm
• LinkedIn: John Kpordje

👤Ezekiel Udiomuno

• GitHub: @Ezzywealth
• Twitter: @EzzyWealth
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [inventory]

(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, feel free to reach out

(back to top)

🙏 Acknowledgments

We would like to express our sincere gratitude and appreciation to everyone who contributed to the development of the Recipe app project. Without your hard work, dedication, and support, this project would not have been possible.

We would like to extend our heartfelt thanks to :

• Microverse: We would like to thank [organization/sponsor name] for their support and resources, which facilitated the successful completion of this project. Your assistance has been crucial in overcoming challenges and achieving our goals.

Once again, we extend our sincere thanks to everyone involved in this project. Your collective efforts have resulted in the creation of the Recipe app, and we are proud of what we have accomplished together.

Best regards,

(back to top)

📝 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)