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

https://github.com/juandbta/recipes-project

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, the app allows you to make them public so anyone can access them.
https://github.com/juandbta/recipes-project

capybara css-flexbox css3 database front-end-development posgresql rspec ruby ruby-on-rails unit-testing

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. Also, the app allows you to make them public so anyone can access them.

Awesome Lists containing this project

README

        

RECIPES PROJECT



logo

# 📗 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)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [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)

# 📖 [RECIPES PROJECT]

**[RECIPES PROJECT]** 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

1- Ruby 3.2.2

2- Rails 7.0.7.2

3- PostgreSQL

4- Gitflow

5- Rubocop

6- RSpec

### Tech Stack

Client

Ruby

Rails

Database

### Key Features

- **[Created rails project]**
- **[Created tables and relations in database]**
- **[Added routes, models and controllers]**

(back to top)

## 🚀 Live Demo

> Add a link to your deployed project.

- [Coming Soon...](https://github.com/JuanDBta/recipes-project)

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

Web Browser (Chrome recommended)

Code editor (VS recommended)

GitHub account

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone "https://github.com/JuanDBta/recipes-project.git"
```
### Install

Go to your /recipes-project folder:

```sh
cd recipes-project
bundle install
rails server
```

### Usage

```sh
rails server
```

### Run Tests

```sh
rspec spec
```

### Deployment

You can deploy this project using:
[Coming Soon!!!](https://github.com/JuanDBta/recipes-project)

(back to top)

## 👥 Authors

👤 **Micronaut JUAN DAVID DIAZ**

- GitHub: [@JuanDBta](https://github.com/JuanDBta)
- Twitter: [@simplebetsas](https://twitter.com/simplebetsas)
- LinkedIn: [LinkedIn](https://linkedin.com/in/simplebet/)

(back to top)

## 🔭 Future Features

- [ ] **[Login page and registration page]**
- [ ] **[Food list]**
- [ ] **[Display a list of food added by the logged-in user as in the wireframe (display also quantity of a given food)]**
- [ ] **[Recipes list]**
- [ ] **[Display a list of recipes created by the logged-in user as in the wireframe]**
- [ ] **[Recipe details]**
- [ ] **[Public recipe list]**
- [ ] **[Display a list of all public recipes ordered by newest as in the wireframe]**
- [ ] **[Display a toggle button that allows for a recipe to be made public or private]**
- [ ] **[Display the recipe details as in the wireframe]**
- [ ] **[Allows the user to add new food]**
- [ ] **[General shopping list view (only for a group that has less than 3 members)]**
- [ ] **[Show the list of food that is missing for all recipes of the logged-in user (compare the list of food for all recipes with
the general food list of that user)]**
- [ ] **[Count the total food items and total price of the missing food]**
- [ ] **[No N+1 queries happening]**
- [ ] **[Navigation menu that allows users to open all of the pages you created]**
- [ ] **[Unit and integration tests]**

(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 me a like, it doesn't cost you anything and it helps me a lot to keep working.

(back to top)

## 🙏 Acknowledgments

We would like to thank Bee in Student Success who is always avalaible to solve issues and Microverse for push us to work hard every day!

(back to top)

## ❓ FAQ

- **["How can I see more projects associated with this author?"]**

- Check my [@JuanDBta](https://github.com/JuanDBta)

- **[How can I contact the author of this project?]**

- Check my [LinkedIn profile](https://linkedin.com/in/simplebet/) or email me at [email protected]

(back to top)

## 📝 License

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

(back to top)