Git Product home page Git Product logo

timbar09 / recipeplug Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 161 KB

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.

License: MIT License

Ruby 66.50% JavaScript 1.28% HTML 28.65% Batchfile 2.83% SCSS 0.74%

recipeplug's Introduction

RecipePlug

๐Ÿ“— Table of Contents

๐Ÿ“– 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 recipies public so that anyone can access them.


๐Ÿ›  Built With

Tech Stack

Client
Server
Database

Key Features

  • 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.

(back to top)

๐Ÿ’ป Getting Started

To get a local copy up and running, follow these steps.

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Timbar09/RecipePlug.git

Prerequisites

In order to run this project you need:

Install

Install this project's dependencies by running:

  cd my-project
  bundle install
  npm install

Usage

To run the project, execute the following command:

  rails server

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Author GitHub Twitter LinkedIn
Miles Mosweu @Timbar09 @Milez09 @miles-mosweu09
Dammy @dammy @dammy @dammy

(back to top)

๐Ÿ”ญ Future Features

  • Add more functionality.

(back to top)

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

โญ๏ธ Show your support

If you like this project, give it a โญ๏ธ and let us know what you like in particular.

(back to top)

๐Ÿ™ Acknowledgments

I would like to thank the microverse community for the useful content

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

recipeplug's People

Contributors

timbar09 avatar bestbynature avatar

Watchers

 avatar

recipeplug's Issues

[2pt] Recipe details - Team member A

  • Should display a toggle button that allows for a recipe to be made public or private.
  • If the recipe is public or the user is the owner of the recipe, should display the recipe details as in the wireframe.
  • If the user is the owner of the recipe, should lead to the form that allows the user to add new food.

[2pt] General shopping list view - Team member B

  • Should show the list of food that is missing for all recipes of the logged-in user
    • compare the list of food for all recipes with the general food list of that user.
  • Should count the total food items and total price of the missing food.

[1pt] Recipes list - Team member A

  • Should display a list of recipes created by the logged-in user as in the wireframe.
  • Should lead to recipe details.
  • If the user is the owner of the recipe, should allow the user to delete it.

[1pt] Food list - Team member B

  • Should display a list of food added by the logged-in user as in the wireframe (display also quantity of a given food).
  • Should lead to a form that allows users to add new food.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.