Git Product home page Git Product logo

recipe_app's Introduction

Ruby on Rails Group Capstone Project - Recipe App

This is a Recipe app that 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

Enjoy!

Built With

  • Ruby
  • PostgreSQL
  • Ruby on Rails
  • IRB
  • Devise
  • CanCanCan
  • RSpec and Capybara Testing Library
  • Bullet gem

Getting Started

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

Pre-requisites

Make sure you have Ruby and Rails installed on your computer. If not, you can follow this tutorial to install them.

If you don't have PostgreSQL installed, you can follow this tutorial

If you don't have yarn installed, you can follow this tutorial

Usage

In your terminal, navigate to your current directory and run this code

git clone https://github.com/ksigei/recipe_app.git

Then run

cd recipe_app

Open the project in your favorite code editor.

  • Use the command bundle install or just simply bundle to install all project dependencies.
  • Run yarn install to install all the JavaScript dependencies.
  • Run yarn build:css to build the CSS files.
  • Run rails db:create db:migrate to create the database and run migrations.
  • You might need to supply a username and password for your PostgreSQL database if you run into an error with the previous step.
  • Simply navigate to config/database.yml and add your username and password to the username and password fields.
  • Run the server

Testing

Within the projects working directory run test using the following command: rspec in the terminal

Author1

๐Ÿ‘ค๐Ÿ‘ค Kiprotich Kimutai

Author2

๐Ÿ‘ค๐Ÿ‘ค Sigei Kiprono

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a โญ๏ธ if you like this project!

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

๐Ÿ“ License

This project is MIT licensed.

recipe_app's People

Contributors

kimutai01 avatar ksigei avatar

Stargazers

ANNIE avatar

Watchers

 avatar

Forkers

kimutai01

recipe_app's Issues

[2pt]General shopping list view

  • Should show the list of food that is missing for all recipes of the logged-in user
  • Should count the total food items and total price of the missing food.
  • Make sure there are no N+1 queries happening.
  • Create a navigation menu that allows users to open all of the pages you created.

[2pt]Public recipe list

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

[2pt]Recipe details

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

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

[2pt] Navbar

Create a navigation menu that allows users to open all of the pages you created.

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.