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

https://github.com/luigirazum/flavorhood-app

FlavorHood is a recipe app that keeps track of all your recipes. It will allow you to save ingredients, keep track of them, 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 to anyone.
https://github.com/luigirazum/flavorhood-app

Last synced: 9 months ago
JSON representation

FlavorHood is a recipe app that keeps track of all your recipes. It will allow you to save ingredients, keep track of them, 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 to anyone.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 About ](#-about-)
- [🛠 Built With ](#-built-with-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 FlavorHood App

FlavorHood 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

- Ruby on Rails
- PSQL
- Webpack

### Key Features

- List recipes with CRUD functionalities.
- List public recipes
- Display food list
- Display general shopping list
- Display inventories list
- Display food list for a given inventory with CRUD functionalities
- Generate Inventory shopping list

(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:

Example command:

```sh
Install Ruby
Install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone git@github.com:luigirazum/flavorhood-app
```

### Usage

To run the project, execute the following command:

```sh
rails s
```

### Run tests

To run tests, run the following command:

```sh
rails test
```

(back to top)

## 👥 Authors

👤 **Faisal Mumtaz**

- GitHub: [@faisalakb](https://github.com/faisalakb)
- Twitter: [@faisalakb786](https://twitter.com/Faisalakb786)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/faisal-mumtaz-514a221a6/)

👤 **Axcell Evans**

- GitHub: [@axcell-0](https://github.com/axcell-0)
- Twitter: [@noumbuh](https://twitter.com/noumbuh)
- LinkedIn: [LinkedIn](https://linkedin.com/in/thierry-noumbuh-a44173257/)

👤 **Luis Zubia**

- GitHub: [@luigirazum](https://github.com/luigirazum)
- Twitter: [@luigirazum](https://twitter.com/LuigiRazum)
- LinkedIn: [@luigirazum](https://linkedin.com/in/luiszubia)

(back to top)

## 🔭 Future Features

- [ ] **Add Food Reservations**
- [ ] **Add Bouffet Ticketing**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

## ⭐️ Show your support

If you like this project, give it a star.

(back to top)

## 🙏 Acknowledgments

Special thanks goes to the Microverse community

(back to top)

## 📝 License

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

(back to top)