Git Product home page Git Product logo

chef-chapters'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. The project is a repository consisting of the following files:

  • Ruby files
  • Rails files
  • Ruby linters file

πŸ›  Built With

Tech Stack

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.
  • Table and column names match the ERD diagram with developed

(back to top)

πŸ’» Getting Started

Prerequisites

In order to run this project you need:

  • Ruby installed and running. To get more information, read the installation instructions.
  • You should be able to use IRB.
  • First of all make sure you have both Ruby & Rails installed in your machine (else You can install Rails just with this simple command gem install rails)

Setup

Clone this repository to your desired folder:

  git clone https://github.com/lorenzoworx/Blog-App.git
  cd Blog-App

Install

Install project dependencies with:

  bundle install

Run localy

  • Then go to the right folder
$ cd Blog-App
$ bundle

and run to install npm package

$ npm install

make sure the database is up and running.

$ rails db:create

When you will add migration file then, you can add command like

$ rails db:migrate

Run this command line to add some dummy data

$ rails db:seed

Run Tests

Go to your gemfile and add the RSpec gem in the development, test group:

group :development, :test do  
 gem 'rspec-rails'
end

Then in your terminal run the command:

 $ bundle install

To set up RSpec in your app and create the Spec folder run:

 $ rails generate rspec:install

To run Request specs locally you need just to run this following command in your terminal :

$ rspec spec/
$ rspec spec/ --format documentation 

(back to top)

πŸ‘₯ Authors

πŸ‘€ Habtamu Alemayehu

πŸ‘€ : lorenzoworx

πŸ‘€ : otmaneechchafyky

(back to top)

πŸ”­ Future Features

  • Optimaze the perfomance of the app.
  • Make the UI more user friendly

(back to top)

🀝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

Give us ⭐️ If you like this project!

(back to top)

πŸ™ Acknowledgments

  • We wanted to take a moment to express my sincere gratitude for the opportunity to work with you all on this project.
  • Microverse, thank you for providing the structure, guidance and community to help me level up my skills as a developer. The experiential learning model has been invaluable in improving my coding abilities and collaboration skills. I appreciate the code reviews and feedback to help me write cleaner, more professional code..

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)

chef-chapters's People

Contributors

benawi avatar otmaneechchafyky avatar lorenzoworx avatar

Watchers

 avatar

chef-chapters's Issues

[2 pt] Inventory Tests

  • Write unit tests for inventories list, inventory details and inventory shopping list
  • Write integration tests for inventories list, inventory details and inventory shopping list

[6 pt] Recipe Details

  • Create UI for displaying recipe details from the given wireframe
  • Implement logic to toggle a recipe between public and private.
  • Implement logic to display recipe details if it's public or owned by the user.
  • Create a UI for users to add new food items to the recipe if they are the owner.
  • Create a modal for choosing an inventory to create a shopping list
  • Implement the logic to associate a recipe with an inventory for creating a shopping list

[2 pt] Inventory Details

  • Create a UI for displaying inventory details using the given wireframe
  • Implement logic to allow users to add new food items to the inventory

[4 pt] Recipes List

  • Design and create UI for displaying the list of recipes according to given wireframes
  • Implement logic to fetch and display recipes created by the logged-in user.
  • Create links from the recipes list to individual recipe details.
  • Implement the ability to delete recipes if the user is the owner.

[4 pt] Inventories List

  • Create a UI for displaying the list of inventories from the given wireframe
  • Implement logic to fetch and display inventories created by the logged-in user.
  • Create links from the inventories list to individual inventory details.
  • Implement the ability to delete inventories if the user is the owner.

Migrations

  • Creating a Migration: To create a new migration, you can use the rails generate migration command
  • Defining Schema Changes

[2 pt] Recipe Tests

  • Unit tests for recipes list, recipe details and recipe details modal
  • Integration test for recipes list, recipe details and recipe details modal

[1pt] Setup the project[group]

  • Config Linters in the project using the Microverse guideline HERE
  • Set up Devise for authentication.
  • Set up RSpec and Capybara testing libraries.

[4 pt] Login Page

  • Create a Devise-based authentication system for user registration.
  • Implement user login functionality.
  • Create the login page UI.

[3 pt] Public Recipe List

  • Create UI for displaying a list of public recipes
  • Implement logic to fetch and display public recipes ordered by newest.
  • Create links from the public recipe list to individual recipe details.

[2 pt] Navigation menu

  • Create a navigation menu that provides links to all the pages you created.
  • Ensure the navigation menu is visible and accessible on all pages.

[3 pt] Inventory Shopping List

  • Implement logic to compare the food items in a recipe with the food items in the selected inventory to find missing items.
  • Calculate the total number of missing food items.
  • Calculate the total price of the missing food items.

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.