Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/sambeck87/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/sambeck87/recipe_app

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 

        






  logo

  






# 📗 Table of Contents



- [📗 Table of Contents](#-table-of-contents)

- [The Recipe app ](#the-recipe-app-)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

    - [Live Demo Version](#live-demo-)

  - [💻 Getting Started ](#-getting-started-)

  - [To get a local copy up and running, follow these steps.](#to-get-a-local-copy-up-and-running-follow-these-steps)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [❓ FAQ ](#-faq-)

  - [📝 License ](#-license-)



#  The 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.

 



This project allows you:



- Create users

- Create foods

- Delete or modify just your foods items

- display a list of your food items

- Create recipes

  - Makes them public or private

- Display a list of your recipes

- Display the recipe details

- Delete just your recipes

- Add ingredients to your recipe

- Delete or modify the ingredients of your recipes

- Create a shopping list







## 🛠 Built With 

- Ruby

- Rails

- Postgresql

- Devise

- Rspec



### Tech Stack 

- Visual code

- RoR

- PostgreSQL



### Key Features 



- Use a database to save, modify and delete information



(back to top)



## Live Demo 



- [Live Demo Version](https://my-recipes-jx0z.onrender.com)



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



- Git

- A GitHub account

- Ruby installed

- Rails installed

- Postgresql installed



### Setup



Clone this repository to your desired folder:



- Go to this repo and copy the project link

        https://github.com/sambeck87/Recipe_app

- Open your terminal and clone the repo with this command

```

git clone https://github.com/sambeck87/Recipe_app.git

```

- Now, you have a copy on your pc.



### Install



Install this project with:



- In your console run the command:

```

bundle install

```



### Usage



To run the project, execute the following steps:



- Setup the database:



- Create a new database by typing this command in your console

```

rails db:create

```

- Migrate the database using this command in your console



```

rails db:migrate

```



- Run the local host

```

rails s

```

- Open your browser and go to the following URL:

http://127.0.0.1:3000



### Run tests



To run tests, run the following command:

```

rspec spec



```



### Deployment



We will update this section soon



(back to top)



## 👥 Authors 



- 👤 **Sandro Hernandez**



  - GitHub: [@sambeck87](https://github.com/sambeck87)

  - Twitter: [@sambeck4488](https://twitter.com/sambeck4488)

  - LinkedIn: [LinkedIn](https://www.linkedin.com/in/sandro-israel-hern%C3%A1ndez-zamora-899386a4/)



- 👤 **Birhanu Gudisa**



  - GitHub: [@GutemaG](https://github.com/GutemaG)

  - Twitter: [@birhanugudisa3](https://twitter.com/birhanugudisa3)

  - LinkedIn: [birhanugudisa](https://linkedin.com/in/birhanugudisa)



(back to top)



## 🔭 Future Features 



- [ ] **It will implement an email confirmation**

- [ ] **It will be able in online version**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



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



(back to top)



## ⭐️ Show your support 



> Write a message to encourage readers to support your project

If you like this project give a ⭐️ or send us a message. We will appreciate



(back to top)



## 🙏 Acknowledgments 



I would like to thank Microverse for the inspiration to be better every day, and my partner that makes this possible



(back to top)



## ❓ FAQ 



- **Can I run this app without Ruby?**



  - No, you can't. You should install Ruby on your SO to use this app



- **Can I use the code of this project**



  - Sure. We will be happy to collaborate on your projects. This project is MIT licensed.



(back to top)



## 📝 License 



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



(back to top)