https://github.com/timbar09/recipeplug
This app keeps track of all user recipes, ingredients, and inventory. It allows the user to save ingredients, keep track of what they have, create recipes, and generate a shopping list based on what the user has and what they are missing from a recipe. The app allows users to make the recipes public so that anyone can access them.
https://github.com/timbar09/recipeplug
Last synced: 9 months ago
JSON representation
This app keeps track of all user recipes, ingredients, and inventory. It allows the user to save ingredients, keep track of what they have, create recipes, and generate a shopping list based on what the user has and what they are missing from a recipe. The app allows users to make the recipes public so that anyone can access them.
- Host: GitHub
- URL: https://github.com/timbar09/recipeplug
- Owner: Timbar09
- License: mit
- Created: 2023-07-31T06:26:51.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-08-04T08:53:51.000Z (over 2 years ago)
- Last Synced: 2025-03-29T11:13:25.721Z (12 months ago)
- Language: Ruby
- Homepage:
- Size: 157 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RecipePlug
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
> This app keeps track of all user recipes, ingredients, and inventory. It allows the user to save ingredients, keep track of what they have, create recipes, and generate a shopping list based on what the user has and what they are missing from a recipe. The app allows users to make the recipies public so that anyone can access them.
Client
Server
Database
- **Recipe Management**
> The app allows users to create and save their own recipes, including ingredients, instructions, and additional details.
- **Ingredient Tracking**
> Users can keep track of their inventory of ingredients, enabling them to manage what they have on hand and what needs to be replenished.
- **Shopping List Generation**
> Based on the recipes and ingredients saved, the app generates a personalized shopping list, highlighting the ingredients needed to prepare desired recipes.
- **Public Recipe Sharing**
> The app provides an option for users to make their recipes public, allowing others to access and view their recipes.
To get a local copy up and running, follow these steps.
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/Timbar09/RecipePlug.git
```
### Prerequisites
In order to run this project you need:
- A text editor.
- To install [Ruby](https://www.ruby-lang.org/en/documentation/installation/).
- To install [Ruby on Rails](https://rubyonrails.org/).
- To install [PostgreSQL](https://www.postgresql.org/).
### Install
Install this project's dependencies by running:
```sh
cd my-project
bundle install
npm install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
| 👤 Author | GitHub | Twitter | LinkedIn |
| :----------- | :--------------------------------------- | :-------------------------------------- | :------------------------------------------------------------ |
| Miles Mosweu | [@Timbar09](https://github.com/Timbar09) | [@Milez09](https://twitter.com/Milez09) | [@miles-mosweu09](https://www.linkedin.com/in/miles-mosweu09) |
| Dammy | [@dammy]() | [@dammy]() | [@dammy]() |
- [ ] **Add more functionality.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Timbar09/RecipePlug/issues).
If you like this project, give it a ⭐️ and let us know what you like in particular.
I would like to thank the microverse community for the useful content
This project is [MIT](./LICENSE) licensed.