๐ Table of Contents
๐ [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.
๐ Built With
Tech Stack
Client
Server
Database
Key Features
- Add Foods
- Display Foods
- Add Recipe
- Display Recipe
- Add Ingredient
- Display Ingredient
- Generate Shopping list
๐ Live Demo
-
Live deployment link works only for one week
๐ป Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
Ruby version - ruby 3.1.2
Rails version - Rails
Chrome Browser
Vscode Optional
Setup
Clone this repository to your desired folder:
git clone https://github.com/Miliyonayalew/recipe-app.git
cd recipe-app
Install
Install this project with:
Run bundle install
Run rails db:create
Run rails db:migrate
Usage
To run the project, execute the following command:
rails server or rails s
Run tests
To run tests, run the following command:
To Run all tests - rspec
To Run model tests - rspec spec/models
To Run integration tests - rspec spec/views
๐ฅ Authors
๐ค Miliyon Ayalew
- GitHub: @Miliyonayalew
- Twitter: @Miliyonayalew
- LinkedIn: Miliyonayalew
๐ค David Tamayo
- GitHub: @IngDavidTM
- Twitter: @David5TM
- LinkedIn: LinkedIn
๐ญ Future Features
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
๐ค Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
โญ๏ธ Show your support
If you like this project please give it a โญ๏ธ!
๐ Acknowledgments
I would like to thank the following people for their support and guidance:
- Microverse
- Code reviewers
- Coding partners
๐ License
This project is MIT licensed.