📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 📝 License

📖 Recipe App

The Recipe app keeps track of all your ingredients, recipes, and public recipes. 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

Tech Stack

Client

• Linters

Server

• ROR

Database

• PostgreSQL

Key Features

• Food list: Displays a list of food added by the logged-in user, and add a new food.
• Recipes list: Display a list of recipes created by the logged-in user, and/delete the recipe.
• Public recipe list: Display a list of all public recipes ordered by newest.
• General shopping list view: Displays the list of food that is missing for all recipes of the logged-in user.

(back to top)

🚀 Live Demo

• Explore this project on Render

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby on Rails installed and running. To get more information, read the installation guide.

• PostgreSQL installed and running.

Setup

Clone this repository to your desired folder:

  git clone git@github.com:KanzaTahreem/Recipe-App.git
  cd Recipe-App
  bundle install
  rails db:create
  rails db:migrate

Install

Install thr project dependencies with:

  bundle install

Usage

To run the project, execute the following command:

  rails server/rails s

Run tests

To run all tests, including unit and integration tests, run the following command:

  rspec

Deployment

You can deploy this project using:

  N/A

(back to top)

👥 Authors

👤 Kanza Tahreem

• GitHub: @KanzaTahreem
• Twitter: @kanza_tahreem
• LinkedIn: kanza-tahreem

👤 Mauricio Mendoza

• GitHub: @rbreva
• Twitter: @rbreva75
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add Inventory
• Add pagination

(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 and want to support me to make cooler projects, please give this project a star. ✨

(back to top)

📝 License

This project is MIT licensed.

(back to top)