📗 Table of Contents

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

📖 Recipes App

Recipes is a Ruby on Rails website that allows user's authentication and authorization, also the user can add foods recipes based on these foods, the recipes can be public or private, also edit and delete foods and recipes. Also if a recipe has more ingredients that there are in the foods pantry, the user can create a shopping list with the neccessary foods to buy.

🛠 Built With

Tech Stack

Key Features

• The user should log in with a real email
• The food pantry will have severals inventories

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

Install Git, Node, Ruby, Rails, PostgreSQL, if you have Linux or Mac, you can follow this tutorial

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone [email protected]:danifromecuador/recipes.git
  cd recipes

Usage

To run the project, execute the following commands, press enter after each line: Maybe you'll need to change the DB name and password to your own. (config/database.yml)

    bundle install
    rails db:drop
    rails db:create
    rails db:migrate
    rails s

After that, open a webpage in your favorite web browser at http://localhost:3000

Test

To test this project just enter this command:

  rspec

(back to top)

👥 Authors

👤 Dani Morillo

• GitHub: danielfromecuador
• LinkedIn: danifromecuador

👤 Alexandre Medina

• GitHub: gersonhiggins

(back to top)

🔭 Future Features

• • Create pagination or infinite scroll if the lists are too long

(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 give me an star on my GitHub repo

(back to top)

🙏 Acknowledgments

I would like to thank to The Odin Project for teaching me about Ruby

(back to top)

📝 License

This project is MIT licensed.

(back to top)