Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/piercel2022/food_recipe_app
https://github.com/piercel2022/food_recipe_app
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/piercel2022/food_recipe_app
- Owner: Piercel2022
- License: mit
- Created: 2023-02-13T14:16:17.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-27T20:25:00.000Z (over 1 year ago)
- Last Synced: 2024-12-06T03:53:37.472Z (about 1 month ago)
- Language: Ruby
- Size: 129 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
FOOD RECIPE APP
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Recipe App\] ](#-recipe-app-)
- [🛠 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)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**The FOOD 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.**
Client
Server
Database
- **Add Foods**
- **Display Foods**
- **Add Recipe**
- **Display Recipe**
- **Add Ingredient**
- **Display Ingredient**
- **Generate Shopping list**
## 🚀 Live Demo
- This application has no live demo yet
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
Ruby version - ruby 3.1.3
Rails version - Rails
Chrome Browser
Vscode Optional
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/Piercel2022/FOOD_RECIPE_APP.git
cd FOOD_RECIPE_APP
```
### Install
Install this project with:
```sh
Run bundle install
Run rails db:create
Run rails db:migrate
```
### Usage
To run the project, execute the following command:
```sh
./bin/dev
rails server or rails s
```
### Run tests
To run tests, run the following command:
```sh
To Run all tests - rspec spec --format documentation
To Run model tests - rspec spec/models
To Run integration tests - rspec spec/views
```
👤 **Onomeh Onwuanibe**
- GitHub:[@Estherstarr](https://github.com/Estherstarr)
- Twitter:[@anibeesther](https://twitter.com/anibeesther)
- LinkedIn:[@onwuanibe-onomeh](https://www.linkedin.com/in/onwuanibe-onomeh/)
👤 **Pierre Celestin Moussa**
- GitHub:[@Piercel2022](https://github.com/Piercel2022)
- Twitter:[@pier_celestin](https://twitter.com/pier_celestin)
- LinkedIn:[@piercelestinmax](https://linkedin.com/in/piercelestinmax)
> Describe 1 - 3 features you will add to the project.
- [ ] **Add Search Recipe and Food**
- [ ] **Add Pagination or infinite scrolling for the lists.**
- [ ] **Improve the UI**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Miliyonayalew/recipe-app/issues).
If you like this project please give it a ⭐️!
I would like to thank the following people for their support and guidance:
- [Microverse](https://www.microverse.org/)
- Code reviewers
- Coding partners
This project is [MIT](./LICENSE) licensed.