Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/v-blaze/recipie_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/v-blaze/recipie_app

cancancan capybara-rspec css postgresql rails rspec-rails ruby ruby-on-rails

Last synced: 5 days 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)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 RECIPIE 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.

### Key Features

- Create new Recipie.
- Create a user account.
- Create Foods from existing recipies

(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
git clone https://github.com/V-Blaze/Recipie_App
```

### Install

Install this project with:

```
cd Recipie-App
bundle install
```
```
Setup database credentials
config/database.yml
```

### Usage

To run the project, execute the following command:

```
Bundle Install
```

```
rails server
```

### Run tests

To run tests, run the following command:

```
rspec spec --format documentation
```

## 👥 Authors

👤 **Valentine Blaze**

- GitHub: [@V-blaze](https://github.com/V-Blaze)
- Twitter: [@blaze_valentine](https://twitter.com/blaze_valentine)
- LinkedIn: [@valentine-blaze](https://www.linkedin.com/in/valentine-blaze/)

👤 **Simeon Trust**

- GitHub: [@githubhandle](https://github.com/Trust-007)
- Twitter: [@twitterhandle](https://twitter.com/simeontrust7)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/trust-simeon/)

(back to top)

## 🔭 Future Features

- Update an existing recipe.
- Add inventory list

(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 give it a ⭐️

(back to top)

## 🙏 Acknowledgments

Thanks [@microverse](https://www.microverse.org/)

(back to top)

## 📝 License

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

(back to top)