rbanos-mv / 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.

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

• Ruby on Rails
• PostgreSQL
• devise / devise-jwt - for authentication
• cancancan - for authorization

Getting Started

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

Prerequisites

• Ruby ruby-3.1.2 installed
• PostgreSQL dbms running

Setup

• Open your terminal and navigate to the folder you would like to save the project.

• Type these commands into the terminal:

git clone https://github.com/rbanos-mv/recipe-app.git
cd recipe-app
bundle install

• You will need a .env file before you install and run the project. The .env file contains environment variables needed to deploy the webpage. There is a commented .env.example file you can use as a guide to configure your own. Type the following commands into the terminal (or Git Bash, if using Windows) to create your .env file:

cp .env.example .env

rails secret

• Edit file .env

  • Provide the values for the variables
    • DATABASE_HOST
    • DATABASE_USER
    • DATABASE_PASSWORD
    • DEVISE_JWT_SECRET_KEY
  • Assign the value returned by the rails secret to DEVISE_JWT_SECRET_KEY.

• Type this commands into the terminal:

rails db:create
rails db:reset

Run application

• Type this command into the terminal:

rails server

• Open your web browser at http://127.0.0.1:3000/

Testing

• Type this command into the terminal:

rspec

Authors

👤 Roberto A. Baños Alvarez

• GitHub: @rbanos-mv
• Twitter: @RobertoBanosMV
• LinkedIn: Roberto A Baños Alvarez

👤 Rafael E. Guzman Arias

• GitHub: @rega1237
• LinkedIn: Rafael E. Guzman Arias

🤝 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

• Microverse for the motivation.

📝 License

This project is MIT licensed.

recipe-app's Issues

[3 pt] Create User model

Create User model in a separate .rb file.

• name

Create migration for the model
Create migration for devise

[2 pt] Create tests for Recipe model

"Create tests for Recipe model

• Test each method in the model"

[2 pt] Create Public recipe list

"Create Public recipe list

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

[2 pt] Create Shopping list page

Create Shopping list page

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

[2 pt] Create tests for Food controller

"Create tests for Food controller

• Test each action in the controller"

Recipe App Kanban Board

Kanban Board

Teams members : 2 members

Team member 1 : @rbanos-mv
Team member 2 : @rega1237

[2 pt] Create RecipeFood controller

"Create RecipeFood controller

• index
• create
• show
• destroy"

[2 pt] Setup Devise

Setup Devise gem for authentication

[3 pt] Create Recipe Detail page

"Create Recipe Detail 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."

[2 pt] Create RecipeFood model

"Create RecipeFood model in a separate .rb file

• quantity

• recipe_id
• food_id

Add validations
Set up associations between models
Create migrations for the model"

[3 pt] Create Navigation menu

"Create Navigation menu

• Include options to open all of the pages
  • Food list
  • Recipe list
  • Shopping list
  • Public recipe list
  • About page"

[2 pt] Setup RSpec & Capybara

Setup RSpec & Capybara for unit and integration testing

[3 pt] Create About Page

"Create About Page

• A simple page with the name of your app
• Description of the app
• Authors"

[2 pt] Create integration tests for Food list page

Create integration tests for Food list page

• Test each use case for the page

[2 pt] Create Registration form

Create Registration form

• Should be built with Devise.

[2 pt] Create Food controller

Create Food controller

• index
• create
• show
• destroy

[2 pt] Create Recipe list page

"Create Recipe list page

• 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.
• with all CRUD implementation, except for 'update'"

[2 pt] Create tests for Food controller

"Create tests for Recipe controller

• Test each action in the controller"

[2 pt] Create Food list page

Create Food list page

• Should display a list of food added by the logged-in user as in the wireframe
  • Display also quantity of a given food.
• Should lead to a form that allows users to add new food.
• with all CRUD implementation, except for 'update'

[2 pt] Create integration tests for Recipe list page

"Create integration tests for Recipe list page

• Test each use case for the page"

[2 pt] Create tests for Food model

"Create tests for Food model

• Test each method in the model"

[2 pt] Create Recipe controller

"Create Recipe controller

• index
• create
• show
• destroy"

[2 pt] Create Login form

"Create Login form

• Should be built with Devise."

[2 pt] Create Recipe model

"Create Recipe model in a separate .rb file

• name
• preparation_time
• cooking_time
• description
• public

• user_id

Add validations
Set up associations between models
Create migrations for the model"

[2 pt] Create Food model

"Create Food model in a separate .rb file

• name
• measurement_unit
• price
• quantity
  *user_id

Add validations
Set up associations between models
Create migrations for the model"

[2 pt] Setup GitHub

Setup GitHub project