Giter VIP home page Giter VIP logo

recipe-app's Introduction

Recipe App


๐Ÿ“— 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

Server
Database

Key Features

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

(back to top)

๐Ÿš€ Live Demo

Not Deployed Yet.

UML Diagram

diagram

(back to top)

๐Ÿ’ป Getting Started

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

Prerequisites

In order to run this project you need:

  • To install ruby on your PC. You can read this documentation on how to do so
  • To install postgresql on your PC. You can read this documentation on how to do so
  • Know how to navigate directories or folders at the CLI.
  • Know how to get the URL(https/ssh) of a repository on GitHub.
  • You should have a code editor installed, preferably VSCode
  • In order to run this project you need:

Setup

In desired folder or directory in the CLI, run the command:

git clone [email protected]:elarhadu/Recipe-App.git

Navigate into the cloned folder or repository by running the command:

cd Recipe-App

If VsCode is your default code editor, run:

code .

You are all set up!

Install

Install this project with:

 bundle install

Usage

To setup the database, run

rails db:drop db:create db:migrate

To run the project, execute the following command:

ruby bin/rails server

Run tests

To run tests, run the following command:

  rspec spec spec/[filename.rb]

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Houda Mzari

๐Ÿ‘ค Emmanuella Adu

(back to top)

๐Ÿ”ญ Future Features

  • This recipe app will provide detailed nutritional information for each recipe, helping users make more informed decisions about their diet.
  • This recipe app will enable users to share and collaborate on recipes, allowing for a community-driven approach to recipe creation and discovery.
  • This recipe app will use data about users' dietary preferences, health conditions, and past recipe choices to suggest personalized recipe recommendations.

(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 us a โญ

(back to top)

๐Ÿ™ Acknowledgments

We would like to thank Microverse for this project inspiration.

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

recipe-app's People

Contributors

elarhadu avatar houdamzari avatar

Stargazers

 avatar SAMUEL KYERE avatar

Watchers

 avatar

recipe-app's Issues

Food list [2pt]

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

Recipes list [2pt]

  • Recipes list:
  • 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.

Recipe details [2pt]

  • Recipe details:
  • 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.

Group Tasks [4pt]

  • Login page and registration page:
    • Should be built with Devise
  • Make sure there are no N+1 queries happening.
  • Create a navigation menu that allows users to open all of the pages you created.
  • Write unit and integration tests

Public recipe list [2pt]

  • Public recipe list:
  • Should display a list of all public recipes ordered by newest as in the wireframe.
  • Should lead to recipe details.

General shopping list view [3pt]

  • General shopping list view (only for a group that has less than 3 members):
  • 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.

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.