Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devmunyi/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/devmunyi/recipe-app
authentication authorization cancancan devise erb mvc postgresql ruby ruby-on-rails rubygems testing
Last synced: 25 days 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.
- Host: GitHub
- URL: https://github.com/devmunyi/recipe-app
- Owner: devMunyi
- License: mit
- Created: 2023-02-06T11:03:16.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-03T10:45:43.000Z (almost 2 years ago)
- Last Synced: 2025-01-09T18:55:48.946Z (29 days ago)
- Topics: authentication, authorization, cancancan, devise, erb, mvc, postgresql, ruby, ruby-on-rails, rubygems, testing
- Language: Ruby
- Homepage:
- Size: 763 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 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)
- [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)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
> 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.
Client
Server
Database
- **[keeps track of all your recipes, ingredients, and inventory]**
- **[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]**
- **[allow you to make recipes public so anyone can access them]**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need followed installed on your computer:
- Ruby v3+,
- Rails v7+
- PostgreSQL
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
git clone https://github.com/devMunyi/Recipe-App
```
- Navigate to the location of the folder in your machine:
**`you@your-Pc-name:~$ cd Recipe-App`**
### Install
To install all dependencies, run:
```
bundle install
```
### Usage
To run the project, follow these instructions:
- After Cloning this repo to your local machine.
- To get it running on your machine, you may open the project on your IDE and open the terminal
- On the terminal you can run:
```
rails s OR rails server
```
- After, you can follow along the app and run the appropriate option from navsigations to interact with it.
### Run tests
- To run rubcop tests, run the following command:
```
rubocop
```
- To run rspec tests, run the following command:
```
rspec
```
👤 **Samuel Munyi**
- GitHub: [@devMunyi](https://github.com/devMunyi)
- LinkedIn: [Samuel Munyi](https://www.linkedin.com/in/samuel-munyi)
- Twitter: [@munyi_sam](https://twitter.com/munyi_sam)
👤 **Tarik Bouari**
- GitHub: [@tarikbouari](https://github.com/tarikbouari)
- LinkedIn: [tarikbouari](https://linkedin.com/tarikbouari)
- Twitter: [@tarikbouari](https://twitter.com/tarikbouari)
- [ ] **Implement more methods.**
- [ ] **Improve the UI.**
- [ ] **Deploy to live server.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project and how I managed to build it!
- The original design ideal from Microverse💕.
- Project from [Microverse](https://bit.ly/MicroverseTN) Ruby / Database and Interviewing module.
- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
- Hat tip to anyone whose code was used.
- **Can I fork and reuse the repository**
- Yes please, feel free.
- **Can I improve the repository, and my changes will be accepted if they are good?**
- Yes please, nice ideas are welcome, please.
This project is [MIT](./LICENSE) licensed.