ab-noori / Recipe-App

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

Recipe Application

Project Login Page

📗 Table of Contents

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

📖 [Recipe Application]

[Recipe-App] The Recipe app keeps track of all your recipes, ingredients, and inventory. It allows 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

• HTML
• CSS
• Bootstrap

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Design the Application]
• [Login page and registration page]
• [Authentication]
• [Navigation menu]
• [General Shopping List]
• [Food list]
• [Recipes list]
• [Recipe details]
• [Public recipe list]
• [Unit and integration tests]
• [RSpec and Capybara testing]

Implemented Schema's ERD

(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 on Rails installed and running. To get more information, read the installation guide.

• PostgreSQL installed and running

(back to top)

Setup

Clone this repository to your desired folder:

  cd my-folder
  https://github.com/ab-noori/Recipe-App.git

(back to top)

Install

Install this project with:

  bundle install

(back to top)

Usage

To run the project, execute the following command:

  rails server

(back to top)

Run tests

To run tests, run the following command:

  rspec spec

(back to top)

👥 Authors

👤 Abdul Ali Noori

• GitHub: @ab-noori
• Twitter: @AbdulAliNoori4
• LinkedIn: abdulali-noori

👤 Baqar Abbas

• GitHub: @Baqar
• Twitter: @BaqarAbbas9
• LinkedIn: Baqar Abbas

(back to top)

🔭 Future Features

• [Inventories list]
• [Inventory details]
• [Recipe details]
• [Inventory 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, give it a star.

(back to top)

🙏 Acknowledgments

First, I would like to thank Microverse and my coding partners.

(back to top)

📝 License

This project is MIT licensed.

(back to top)