mohamedSabry0 / recipe_app

Create, delete, and share recipes. Easily manage ingredients, explore public recipes, and generate shopping lists based on your inventories.

Recipe App

📗 Table of Contents

• 📖 Recipe On Rails
  • 📺 [Live Demo]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Recipe On Rails

Recipe App is a web application that allows users to create, and delete recipes, and inventories. It also allows users to add ingredients to their inventories, and add ingredients to their recipes. Users can also view other users' public recipes, and create shopping lists for a recipe based on the ingredients available in their inventory.

📺 [Live Demo]

• Testing Version
• Staging Version

🛠 Built With

Tech Stack

Server

Ruby

Rails

Database

Postgres

Key Features

• Built using Ruby on Rails

(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 >= 3.2.2
    rails >= 7.0
    postgres >- 15.3

Setup

Clone this repository to your desired folder:

  git clone [e-mail]:mohamedSabry0/recipe_app.git

Install

Install this project with:

  cd recipe_app
  bundle install

it will install the required gemfile for running the project

run the following commands to create and migrate:

  rails db:create
  rails db:migrate

Usage

to use this project:

   bin/rails server

Or

   rails server

it will run the the server on localhost:3000

to run tests:

   rspec

(back to top)

👥 Authors

👤 Mohamed Sabry

• GitHub: @mohamedSabry0
• Twitter: @mohsmh0
• LinkedIn: LinkedIn

👤 Stanley Ramos

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Abu Talha

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add Events
• Add Calories
• Add Relevant Nutrition Facts
• Enable different login options
• Add a search bar
• Add a filter option
• Add a rating system

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page. You are welcome to fork the repository and modify the code. We encourage pull requests.

(back to top)

⭐️ Show your support

Give a star⭐️ or a thumbs up 👍 if you like this project! You can visit my GitHub profile for more of my projects.

(back to top)

🙏 Acknowledgments

• Project supervised by Microverse
• Creative Commons 4.0 License

(back to top)

📝 License

This project is MIT licensed.

(back to top)