tajulafreen / recipe-app

[Recipe App] The Recipe app keeps track of all your foods, recipes, and ingredients. It allows you to save ingredients, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 [Recipe App]

[Recipe App] The Recipe app keeps track of all your foods, recipes, and ingredients. It allows you to save ingredients, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

🛠 Built With

Tech Stack

• Ruby
• Rails
• Postgresql

Key Features

• [A login page]
• [Adding foods and creating recipes]
• [A general shopping list view]
• [Use validations for models]
• [Write unit tests for models]
• [Write request tests for models]
• [Set up the view model]
• [Use preprocessed HTML file with embedded Ruby code.]
• [Use layouts and templates for shared content.]

(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 the following installed in your local system

• Ruby
• Git CLI
• Github account

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:tajulafreen/Recipe-app.git

Install

Install gems with:

  bundle install

Setup database with:

rails db:create
rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Visit http://localhost:3000/ in your browser.

Run tests

• Install npm with:
• Install rspec with:

  bundle install

and

  rails generate rspec:install

run the test with:

  rspec spec

(back to top)

👥 Authors

👤 Foga Kater Amos

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Tajul Afreen

• GitHub: Tajul Afreen
• LinkedIn: Tajul Afreen

🔭 Future Features

• [Build the front end of the system]
• [Style the front end]

(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 please leave a STAR to the Github repo

(back to top)

🙏 Acknowledgments

I would like to appreciate Microverse for providing the resources and the platform for us to be a Professional full-stack developer.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

recipe-app's Issues

[2pt] Display a list of recipes

• Display a list of recipes created by the logged-in user.
• Follow the wireframe given for displaying
• Should lead to recipe details.

[3pt] Add Recipe test

• Add unit test for Recipe
• Add integration test for Recipe

[3pt] Add Food tests

• Add unit test for food modal
• Add integration test for food methods

[2pt] Display public recipes

• Display a list of all public recipes.
• Order them from the newest.
• This should lead to recipe details.

[2pt] Display a list of food

1. Should display a list of food added by the logged-in user as in the wireframe.
2. display the quantity of a given food.
3. Follow the wireframe

[1.5pt] Allow User to delete recipe

If the user is the owner of the recipe:

• Create a delete button on the list of all recipes.
• It should allow the user to delete it.

[2pt] Add a new food

• Create a form that allows users to add new food.

[0.5pt] Login page and registration page

Should be built with Devise.

[2pt] Create Recipe detail page

• Display the details of the recipe
• Should display a toggle button allowing a recipe to be made public or private.
• Create a button to add a new food.
• If the recipe is public or the user owns the recipe, it should display the recipe details as in the wireframe.

[1.5pt] Solve N+1 queries

• Solve N+1 queries if there are any.
• Make sure there are no N+1 queries happening.

[1pt] Add navigation

• Add navigation
• Add the link to every page created

[0.5pt] setup

Set up the project

Setup kanban board

Hi,
There are two people on the team @katfogy and @tajulafreen
Here is the link to our project:
LINK

[2pt] Create 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 number of food items and the total price of the missing food.