Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/adarachel/recipeapp

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/adarachel/recipeapp

Last synced: about 1 month 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

        

ruby


Rails Recipe App


# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 Recipes 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

Client

Database

### Key Features

- **Add/Remove recipes**
- **Display recipes**
- **Modify Recipe Foods**
- **Add foods**
- **Generate 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:

```sh
gem install rails
```

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/adarachel/recipeapp.git
```

-

### Install

Install this project with:

```sh
cd my-folder
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
```

(back to top)

## 👥 Authors

👤 **Ada Rachel**

- GitHub: [@adarachel](https://github.com/adarachel)
- Twitter: [@adarachel_dev](https://twitter.com/adarachel_dev)
- LinkedIn: [@AdaRachel](https://www.linkedin.com/in/adarachel/)

👤 **Ragan Hailu**

- GitHub: [@githubhandle](https://github.com/ragangithub)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/raganhailu)

(back to top)

## 🔭 Future Features

- [ ] **Create a modal to choose an inventory to create a shopping list with, as in the wireframe**
- [ ] **Implement Pagination or infinite scrolling for the lists.**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/adarachel/recipeapp/issues).

(back to top)

## ⭐️ Show your support

If you like this project please give it a star 🌟

(back to top)

## 🙏 Acknowledgments

Microverse.

(back to top)

## 📝 License

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

(back to top)