📗 Table of Contents

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

📖 [Recipe App]

The Recipe app provides a comprehensive solution for managing recipes, ingredients, and inventory. You can save ingredients and track what you have on hand, create recipes, and generate a shopping list based on what you need for a recipe. Additionally, the app allows you to make your recipes public, facilitating easy sharing with others who may find them useful in their own cooking endeavors.

• View Recipes for the logged in user
• logged in user can delete their recipes
• Logge in user can add new recipes
• Logged in user can make the recipe public or private
• Public recipes can be viewd by any user

🛠 Built With

Tech Stack

Server

• Ruby on rails

Database

• PostgreSQL

Key Features

• Add new recipes
• Delete recipes
• Make recipe public or private
• generate shopping list for missing ingredients in the inventory

(back to top)

Getting Started

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

Prerequisites

You need the following tools be installed in your computer:

• Rails
• Git
• Ruby
• IDE
• PostgreSQL
• Node.js

Setup

Clone this repository to your desired folder:

  cd my-prefered-folder
  
  git clone https://github.com/Kashif-Saleem-Ghuman/recipe-app.git

Install

Install this project with:

  cd recipe-app
  
  bundle install

Database creation

Next, use this command to create the databases:

rails db:create
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:

before you run the tests

rails db:seed RAILS_ENV=test

  rspec spec/

or :

rspec spec/models
rspec spec/views

👥 Authors

👤 Kashif

• GitHub: Kashif
• Twitter: Kashif
• LinkedIn: Kashif

👤 Wahaj Ali

• GitHub: @Wahaj-Ali
• LinkedIn: @wahaj-ali96

👤 Saeqa

• GitHub: SaeqaSultani
• Twitter: SaeqaSultani
• LinkedIn: SaeqaSultani

(back to top)

🔭 Future Features

• Edit Reccipes
• Edit Price of ingredient
• Edit ingredients
• Edit shopping list

(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 a⭐️ and share with your friends.

(back to top)

🙏 Acknowledgments

• Thanks to the Microverse team for the great curriculum.
• Hat tip to anyone whose code was used

(back to top)

📝 License

This project is MIT licensed.

(back to top)