barakadanny / Recipe-app

📗 Table of Contents

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

📖 Recipe app

Welcome to our recipe app! This app is designed to help you find, save, and organize your favorite recipes. With a variety of features such as a recipe list, a shopping list, and the ability to add your own recipes, our app is the perfect tool for any home cook. Whether you're a beginner or a seasoned pro in the kitchen, we hope you'll find our app helpful and enjoyable to use.

🛠 Built With

Tech Stack

• Ruby on rails
• PostgreSQL
• Tailwind
• Css

Database

• PostgreSQL

Key Features

• Recipe list: Browse a list of recipes, search for specific recipes, and view detailed information about each recipe, including ingredients and instructions
• Shopping list: Add ingredients from recipes to a shopping list and mark items as purchased

(back to top)

🚀 Live Demo

• Comming Soon 🎈

(back to top)

💻 Getting Started

In order to start with this project do as follows :

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:

git clone https://github.com/barakadanny/Recipe-app.git

Install

Install this project with:

bundle install

Usage

rails s / or /bin/dev

Run Linters

To run tests, run the following command:

rubocop

OR

rubocop -a

it will automatically correct the errors

(back to top)

👥 Authors

👨‍💻 Baraka Danny

• GitHub: @barakadan
• LinkedIn: danny baraka

👨‍💻 Muskan

• GitHub: @barakadan

(back to top)

🔭 Future Features

• Personal recipes: Add your own recipes to the app and organize them into categories
• Recipe ratings: Rate and review recipes to help other users discover the best recipes
• Recipe recommendations: Get personalized recipe recommendations based on your tastes and preferences
• Meal planning: Plan your meals for the week and generate a shopping list based on your plan

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project then please give a ⭐️ and also share your feedback using github_issues.

(back to top)

🙏 Acknowledgments

❤️ RoR Documentation

(back to top)

📝 License

This project is MIT licensed.

(back to top)