An open API service indexing awesome lists of open source software.

https://github.com/billymohajeri/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.
https://github.com/billymohajeri/recipe-app

postgresql ruby-on-rails

Last synced: 3 months ago
JSON representation

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.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Create database](#create-database)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Recipe app

**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. 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

### Key Features

- **Create recipes**
- **Add food**
- **Make recipes public**
- **Delete recipe**

(back to top)

## 🚀 Live Demo

- [Not deployed yet...]()

(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](https://rubyonrails.org/) installed and running. To get more information, read the [installation guide](https://guides.rubyonrails.org/).

- [PostgreSQL](https://www.postgresql.org/) installed and running.

### Setup

Clone this repository to your desired folder:

```
git clone git@github.com:billymohajeri/Recipe-App.git
```

### Install

Install this project with:

```cd Recipe-App```

```bundle install``` to install all gems used.

```rails db:create``` to create the database.

```rails db:migrate``` to run the database migrations you created.

### Usage

To run the project, execute the following command:
```
rails s
```

(back to top)

## 👥 Authors

👤 **Billy Mohajeri**

- GitHub: [@BillyMohajeri](https://github.com/billymohajeri)
- Twitter: [@BillyMohajeri](https://twitter.com/BillyMohajeri)
- LinkedIn: [@BillyMohajeri](https://www.linkedin.com/in/billymohajeri)

👤 **Leehaney George**

- GitHub: [@githubhandle](https://github.com/leehaney254)
- Twitter: [@twitterhandle](https://twitter.com/Lee06785586)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/leehaney-george-0a4a51178/)

(back to top)

## 🔭 Future Features

- [ ] **Delete Food**
- [ ] **Improve styling**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project, please consider giving it a star.

(back to top)

## 🙏 Acknowledgments

- I would like to thank all code reviewers for making this project better.

(back to top)

## 📝 License

This project is [MIT](./LICENSE/MIT.md) licensed.

(back to top)