https://github.com/onjoseph/recipe-app
https://github.com/onjoseph/recipe-app
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/onjoseph/recipe-app
- Owner: ONJoseph
- License: mit
- Created: 2023-04-24T15:55:03.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-01T17:43:49.000Z (about 2 years ago)
- Last Synced: 2025-01-28T14:52:28.276Z (4 months ago)
- Language: Ruby
- Size: 938 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Recipe App
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo & Project Presentation](#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)
- [📝 License](#license)
**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. These are some of the interfaces and some wireframes for some of them:
- **A login page.**
- **A registration page.**
- **A food list (with all CRUD implementation, except for 'update').**
- **A recipes list (with all CRUD implementation, except for 'update').**
**A general shopping list view (all missing food for all your recipes and total price).**
**A list of all public recipes from other users with their names and total prices.**
## Project requirements
### General requirements
- Make sure that there are [no linter errors](https://github.com/microverseinc/linters-config).
- Make sure that you used correct [Gitflow](https://github.com/microverseinc/curriculum-transversal-skills/blob/main/git-github/articles/gitflow.md).
- Make sure that you documented your work [in a professional way](https://github.com/microverseinc/curriculum-transversal-skills/blob/main/documentation/articles/professional_repo_rules.md).
### Ruby requirements
- Follow our list of [best practices for Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/articles/ruby_best_practices.md).
- Ruby
- Ruby on Rails
- JavaScript
- PostgreSQL
- GitHub
- CSS/SCSS(Bootstrap)
- Set up the ROR project and install the Devise gem
- Create the food and recipe models and their associations
- Implement the food list feature
- Implement the recipe list feature
- Implement the public recipe list feature
- Implement the recipe toggle feature
- Implement the general shopping list feature
- Write unit and integration
## 🚀 Live Demo & Project Presentation
- Live Demo coming soon...
### Prerequisites
Everything will be based on the ERD class diagram presented below.
Entity Relationship Diagram (ERD) of Recipe App project
## Getting Started
To run the project locally, copy up and running follow these simple example steps :
- First of all make sure you have both `Ruby` & `Rails` installed in your machine
(else You can install `Rails` just with this simple command ```gem install rails```)
```
$ git clone ### Setup
- Clone this repository to your computer: git clone https://github.com/ONJoseph/recipe-app.git
```
- Then go to the right folder
```
$ cd recipe-app
```
```
$ bundle
```
and run to install npm package
```
$ npm install
```
make sure the database is up and running.
```
$ rails db:create
```
When you will add migration file then, you can add command like
```
$ rails db:migrate
```
Run this command line to add some dummy data
```
$ rails db:seed
```
- Finaly run `rails s` and visit http://localhost:3000/ in your browser!
## Run tests :
To run Request specs locally you need just to run this following command in your terminal :
```
$ bundle exec rspec
```
### Install
- Write: bundle install
- Write: npm install
### Usage
- To test the app:
- rspec (general)
- rspec spec/unit/name_of_sile (specific one)
👤 **Joseph Ogbole**
- GitHub: [@ONJoseph](https://github.com/ONJoseph)
- Twitter: [@ONJoseph1](https://twitter.com/ONJoseph1)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/o-n-joseph-ba8425147/)
👤 **Ivan Martinez von Halle**
- GitHub: [@ivanmvh](https://github.com/ivanmvh)
- Twitter: [@imprivado](https://twitter.com/imprivado)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ivan-martinez-von-halle/)
- [ ] Add Inventories list
- [ ] Add Inventory details
- [ ] Add Recipe details
- [ ] Add Inventory shopping list
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ONJoseph/recipe-app/issues).
I really enjoyed working on this project. If you like it show your support by giving a star.
Hat tip to anyone whose code was used.
This project is [MIT](https://github.com/ONJoseph/recipe-app/blob/dev/LICENCE) licensed.