Giter VIP home page Giter VIP logo

kanzatahreem / recipe-app Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 1.0 686 KB

The Recipe app keeps track of all your ingredients, recipes, and public recipes. It allows users to save ingredients, keep track of what they have, create recipes, and generate a shopping list based on what they have and what they are missing from a recipe.

Home Page: https://recipe-app-usaa.onrender.com/

License: MIT License

Ruby 64.96% JavaScript 1.16% CSS 7.57% HTML 26.17% Shell 0.15%
bullet cancancan capybara-rspec crud database devise psql ruby ruby-on-rails

recipe-app's Introduction

๐Ÿ“— Table of Contents

๐Ÿ“– Recipe App

The Recipe app keeps track of all your ingredients, recipes, and public recipes. 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

Client
Server
Database

Key Features

  • Food list: Displays a list of food added by the logged-in user, and add a new food.
  • Recipes list: Display a list of recipes created by the logged-in user, and/delete the recipe.
  • Public recipe list: Display a list of all public recipes ordered by newest.
  • General shopping list view: Displays the list of food that is missing for all recipes of the logged-in user.

(back to top)

๐Ÿš€ Live Demo

  • Explore this project on Render

(back to top)

๐Ÿ’ป Getting Started

Prerequisites

In order to run this project you need:

Setup

Clone this repository to your desired folder:

  git clone [email protected]:KanzaTahreem/Recipe-App.git
  cd Recipe-App
  bundle install
  rails db:create
  rails db:migrate

Install

Install thr project dependencies with:

  bundle install

Usage

To run the project, execute the following command:

  rails server/rails s

Run tests

To run all tests, including unit and integration tests, run the following command:

  rspec

Deployment

You can deploy this project using:

  N/A

(back to top)

๐Ÿ‘ฅ Authors

๐Ÿ‘ค Kanza Tahreem

๐Ÿ‘ค Mauricio Mendoza

(back to top)

๐Ÿ”ญ Future Features

  • Add Inventory
  • Add pagination

(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 and want to support me to make cooler projects, please give this project a star. โœจ

(back to top)

๐Ÿ“ License

This project is MIT licensed.

(back to top)

recipe-app's People

Contributors

kanzatahreem avatar rbreva avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

recipe-app's Issues

[3pt] General shopping list view

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

Setup Kanban Board

Hey Reviewer ๐Ÿ‘‹

Regarding this issue, we covered the following project requirements ๐Ÿ”ฝ

  • Create an empty repository for your group project.
  • Open the GitHub project (Kanban board) in your team repo
  • Create tasks on your Kanban board based on the project requirements.
  • Each task should be a separate card with descriptive title and number of points in the [Xpt] prefix
  • Each of the team members should assign themselves to the cards.
  • Decide who will be the assignee for the cards marked as group tasks. All cards on your Kanban board should have assignees.
  • Open a new issue in your repository and send it for review

Project Link ๐Ÿ”—

Here is the link for Kanban board created for the project

Group Members ๐Ÿ˜„

@rbreva
@KanzaTahreem

[3pt] Create a Food list

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

[3pt] Create Recipe details page

  • 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] Design the application

  • You should follow the layout of the wireframes provided. You should personalize the rest of the design including colors, typographies, spacings, etc.

[4pt] Create 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.

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.