shella12 / recipe-app

Recipe app is a Ruby on Rails app that helps you plan and organize your cooking. With Recipe app, you can easily store and manage your ingredients, inventory, and recipes. You can also generate shopping lists based on your recipes and share your recipes with other users.

📗 Table of Contents

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

📖 [Recipe-app]

With the Recipe app, you can organize and manage your cooking with ease. You can save and track your ingredients, inventory, and recipes in one place. You can also generate a shopping list based on what you need for a recipe or what you have in stock. And if you love to share your recipes with others, you can make them public and let anyone enjoy them.

🛠 Built With

Tech Stack

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• Show list of public and private recipes
• Create Shopping list
• Authentication
• Authorization
• Interactive Navbar

(back to top)

Live demo

Click link to see live demo

(back to top)

💻 Getting Started

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

Prerequisites

• Ruby (ruby --version)
• SQLite3 (sqlite3 --version)
• Node.js (node --version)
• Yarn (yarn --version)

Install

Since Rails started out as a project full of packages and libraries, and has since become the full-stack framework it is, it can be easy to forget that it is also just a package itself. If these are all good, you can check:

• Rails (rails --version)

If you get a good version, you're ready to go! (Almost). If you didn't, you may still need to install the Rails gem.

gem install rails

It can be good to keep in mind which version you're using as each of these will update on their own schedule and sometimes the code changes just enough to give us bugs. This will be true for all the packages, gems, APIs, or any other dependencies you may bring into your projects as a developer.

Setup

Clone this repository to your desired folder:

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

Run

To run this app on your local environment you need to run bundle install

Usage

You need to get your Rails application server running,in order to see your app in the browser. This is like live preview in the browser for rails applications. Run :

 $ bin/rails server

OR

$ rails s

visit localhost in your browser!

To exit server enter “Control (^ )+ C”

Tests

To create tests, RSpec testing framework is used. In order to run tests use following command:

 $ rspec spec

Note: You can also run the test by using just rspec but it runs all tests folders and files with name like ****_spec

(back to top)

👥 Authors

👤 Ayesha Arshad

• GitHub: @shella12
• Twitter: @Ayesha Arshad
• LinkedIn: Ayesha Arshad

👤 Zuhra Hashimi

• GitHub: @ZuhRa-HashiMi
• LinkedIn: Zuhra Hashmi

(back to top)

🔭 Future Features

• Improving UI
• Make an API of this app

(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 give this repo a star ⭐️

(back to top)

🙏 Acknowledgments

Project architecture and requirments provided by Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)

recipe-app's Issues

Create registration page [1pt]

• Should be built with Devise.
• Customise view of the login page.

Write unit and integration tests for public recipes list view [2pt]

• Write unit tests
• Write integration test using Capybara

Create recipe details page [5pt]

• Should display a toggle button that allows for a recipe to be made public or private.

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

Create public recipe list [3pt]

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

Create shopping list page [3pt]

• Should display a general shopping list

• User can add all missing food for all recipes and total price

• Use this wireframe:

Login page and registration page

Create a Login page and registration page:

• Should be built with Devise.

ROR Project Kanban Board

• Created tasks on Kanban board based on the project requirements.

• Each task has a separate card that:

• Has a descriptive title.

• Has the number of points in the [Xpt] prefix. That number indicates the number of points that show how complex the task is. 1 point = 1 hour of estimated work.

• Has a description of the task.

We are a team of two namely @shella12 and @ZuhRa-HashiMi . Here is the link to the Project

Create a food list page [3pt]

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

Create a recipes list page [3pt]

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

Write unit and integration tests for a recipes list page[2pt]

• Write unit tests
• Write integration test using Capybara

Write unit and integration tests for shopping list view [2pt]

• Write unit tests
• Write integration test using Capybara

Create a login page [1pt]

• Should be built with Devise.
• Customise view of the login page.

Create a navigation menu [2pt]

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

Write unit and integration tests for food list [2pt]

• Write unit tests
• Write integration test using Capybara

Setup recipe app and create models from UML [5pt]

• Setup project by creating work folders
• Setup Model using below UML diagram