OsvaldoBC / recipe

The Recipe app keeps track of all your recipes, ingredients, and inventory.

a name="readme-top">

RECIPE

📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features

• 💻 Getting Started

  • Prerequisites
  • Setup
  • Install
  • Usage

• 👥 Authors

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• 📝 License

📖 [RECIPE]

[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 v3.2.2
• Rails v7.0.5
• Postgresql v15.3
• Devise
• CanCanCan
• Bullet
• Rspec
• Capybara

Tech Stack

Language

• Ruby v.3.2.2

Server

• Rails

Database

• PostgreSQL

Key Features

• [User login and sign up]
• [Food, personal recipes and public recipes]
• [Recipies details]
• [Shopping list]

(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:

Have a suitable installation of Ruby v3.2.2 Have a suitable installation of Postgresql v15

install Rails

 gem install rails

Setup

Clone this repository to your desired folder:

gh repo clone OsvaldoBC/recipe

--->

Install

Install this project with:

  cd recipe
  bundle install
  rails db:setup
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Open the following ing in your web browser http://localhost:3000

Run tests

To run tests, run the following command:

Example command:

  rspec

(back to top)

👥 Authors

👤 Osvaldo Barrios

• Twitter : @OsvaldoBarrio20
• GitHub : @OsvaldoBC
• LinkedIn: osvaldo-barrios-data-science

👤 Giancarlo Dumani

• GitHub: gdumani
• Twitter: gdumani
• LinkedIn: Gaincarlo Dumani

(back to top)

🔭 Future Features

• [Inventory list and details]
• [Shopping list based on in inventory availabilty ]

(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 coomment or send it a star

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for suggesting the app

(back to top)

📝 License

This project is MIT licensed.

(back to top)