📗 Table of Contents

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

---

Recipe app

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

These is the ERD for the project:

---

🛠 Built With

Tech Stack

The project is built using the following technologies:

• Ruby on Rails.
• PostgreSQL.
• RSpec.
• Rubocop.
• Stylelint.

---

Key Features

• [x] Create and delete recipes and ingredients.
• [x] 'Make public' option to share recipes with other users.
• [x] User authentication.
• [x] Responsive design.

Please note: Each feature will be marked with an "x" when it is fully implemented and operational.

• HTML & CSS3
• Ruby on Rails
• Linters
  • Rubocop
  • StyleLint
• Follow Microverse's list of best practices

(back to top)

---

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

• Installed Ruby and Ruby on Rails.
• If you're using Windows, have installed WSL.
• If you're using MacOS, an option is using UTM.

Setup

To clone this repository to your desired folder, run the following command:

git clone https://github.com/grauJavier/recipe-app.git

Navigate to the cloned repository and run the following command to install the necessary gems:

cd blog-app
bundle install

(back to top)

Usage

Initialize it with

rails server

Then open http://localhost:3000 in your browser.

(back to top)

Test

To run the tests try the following command:

rspec spec

(back to top)

(back to top)

---

👥 Authors

👤 Javier Grau

• GitHub: @grauJavier
• Twitter: @jgrauchile
• LinkedIn: LinkedIn

👤 Ruth Abreu

• GitHub: @Ruthmy
• Twitter: @rury_exe
• LinkedIn: LinkedIn

(back to top)

---

🔭 Future Features

Upcoming improvements:

• [ ] Search functionality for locating specific articles.
• [ ] User profiles with customizable avatars.

(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 and know someone who might find it helpful, please share it. Or give it a star ⭐️

(back to top)

---

🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)

---

📝 License

This project is MIT licensed.

(back to top)

---