📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgements
  • 📝 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.

🛠 Built With

Tech Stack

Client

• Linters

Server

• ROR

Database

• PostgreSQL

Key Features

• User can add foods and recipes
• User can add ingredients to his recipes
• User can generate a shopping list

(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 https://github.com/AbeeraTahir/Recipe-App.git

Install

Install the project dependencies with:

  - bundle install
  - npm install

Usage

To run the project, execute the following command:

  rails s

Run tests

To run tests, run the following command:

rspec

(back to top)

👥 Authors

👤 Abeera Tahir

• GitHub: @AbeeraTahir
• Twitter: @AbeeraTahir8
• LinkedIn: Abeera Tahir

👤 Italo Lon Kan

• GitHub: @storres20
• Twitter: @italolonkan
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add inventory feature
• Improve UI

(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 make cooler projects Give this project a Star.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse community.

(back to top)

📝 License

This project is MIT licensed.

(back to top)