Alejandro-Bernal-M/recipe-app

The Recipe app keeps track of all your recipes, ingredients, and inventory. It 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.

📗 Table of Contents

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

📖 recipe-app

recipe-app is an app created with Ruby on Rails. It keeps track of recipes and ingredients. 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.

🛠 Built With

• Ruby on Rails

Tech Stack

Client

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Registration and login page built with devise]
• [Users can create and list recipes and food]
• [A list of all public recipes from other users with their names and total prices]
• [Users can list a shopping list of missing food for their recipes]

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

• Ruby version 3.1.3 or later
• Rails version 7 or later
• Postgresql

Setup

Clone this repository to your desired folder:

  git clone https://github.com/Alejandro-Bernal-M/recipe-app.git
  cd recipe-app

Install

Install this project with:

bundle install

Usage

To start the server, execute the following command:

rails server

Run tests

To run tests, run the following command:

rspec

(back to top)

👥 Authors

👤 Alejandro

• GitHub: Alejandro
• LinkedIn: LinkedIn

👤 Alejandra Keber Maggi

• GitHub: @AlejandraKeber
• Twitter: @KeberAlejandra
• LinkedIn: alejandra-keber

🔭 Future Features

• [API endpoints]
• [Better design]

(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 it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank

• Microverse for the opportunity.
• Code Reviewers
• Coding Partners

(back to top)

📝 License

This project is MIT licensed.

(back to top)