Recipes App

<a name="readme-top"></a>

<!-- TABLE OF CONTENTS -->

📗 Table of Contents

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

📖 Blog App <a name="about-project"></a>

Recipes App The Recipe App is a web application built using the Ruby on Rails framework, that provides users with a platform to create, modify and remove recipes. Users can decide whether to make their recipes public or private, depending on whether they want to share them with others or keep them to themselves. Moreover, the app has a useful feature that allows users to generate a shopping list based on the food items required for their selected recipes.

• Services (job queues, cache servers, search engines, etc.)

🛠 Built With <a name="built-with"></a>

Tech Stack <a name="tech-stack"></a>

This project was implemented using:

<details> <summary>Framework</summary> <ul> <li><a href="https://rubyonrails.org/">Ruby on Rails</a></li> </ul> </details> <details> <summary>Database</summary> <ul> <li><a href="https://www.postgresql.org/">PostgreSQL</a></li> </ul> </details>

Key Features <a name="key-features"></a>

• Can persist user data to database
• Can persist recipes data to database
• Can persist foods database

<p align="right">(<a href="#readme-top">back to top</a>)</p>

💻 Getting Started <a name="getting-started"></a>

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

Prerequisites

In order to run this project you need to have installed:

• [ ] install ruby

• [ ] install postgresql

• [ ] You’ll need to have Ruby and Rails on your machine.

Optionally, in order to modify this project you should to have installed:

• [ ] Git.

• [ ] Code editor like: Visual Studio code, or others...

Setup

To clone this repository to your desired folder:

• You can download the Zip file from the GitHub repository, or clone the repository with:

git clone https://github.com/rmrmrmr/Recipes-App.git

• Access the cloned directory with:

cd Recipes-App

• Open it with your favorite code editor or with the live server

Install

To run the project, execute the following command in the project directory:

    bundle install
    rails db:create
    rails db:migrate

Tests

To run the tests run the following commands:

Install gems

  bundle install

Run tests

  rspec spec

Usage

To run the project, execute the following command in the project directory:

rails server

<p align="right">(<a href="#readme-top">back to top</a>)</p>

👥 Authors <a name="authors"></a>

👤 Ricardo Martínez

• GitHub: @rmrmrmr
• Twitter: @ricmtza
• LinkedIn: LinkedIn

👤 Gabriel Cilfone

• GitHub: Gabriel Cilfone
• LinkedIn: Gabriel Cilfone

<p align="right">(<a href="#readme-top">back to top</a>)</p>

🔭 Future Features <a name="future-features"></a>

We will implement this on the future:

• [ ] Users can create, modify and delete recipes.
• [ ] Users can decide whether to make their recipes public or private.
• [ ] Allows users to generate a shopping list based on the foods needed for their selected recipes.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

⭐️ Show your support <a name="support"></a>

Give a ⭐️ if you like this project!

<p align="right">(<a href="#readme-top">back to top</a>)</p>

🙏 Acknowledgments <a name="acknowledgements"></a>

• Microverse

<p align="right">(<a href="#readme-top">back to top</a>)</p>

📝 License <a name="license"></a>

This project is MIT licensed.

<p align="right">(<a href="#readme-top">back to top</a>)