mohametalmeari / Recipe-App-RoR

MIT License
0 stars 1 forks source link

logo

Recipe App - README

πŸ“— Table of Contents

πŸ“– Catalog of My Things

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. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.

UML class diagram

πŸ›  Built With

Tech Stack

Client
Database

Key Features

(back to top)

πŸ’» Getting Started

Prerequisites

In order to run this project you need:

sh gem install bundler

Setup

Clone this repository to your desired folder:

sh cd my-folder git clone https://github.com/mohametalmeari/Recipe-App-RoR.git

Install

Install this project with:

sh cd my-things bundle install

Usage

To run the project, execute the following command:

sh rails server

Run tests

To run tests, run the following command:

sh rspec spec

(back to top)

πŸ‘₯ Authors

πŸ‘€ Mohamad

πŸ‘€ Shalini Nayan

(back to top)

πŸ”­ Future Features

(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 it a star ⭐.

(back to top)

πŸ™ Acknowledgments

The original design idea for this web page was created by Microverse Team.

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)