📗 Table of Contents

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

📖 Recipe-App

Recipe-App is an application where you can save your favorite recipes, ingredients and make a comparison to know how many ingredients you are missing in quantity in order to prepare your favorite meals.

🛠 Built With

Tech Stack

In these apps we implement the devise gem to authenticate the user and you can have your recipes securely saved.

Client

• Ruby on Rails

Server

• Ruby

Database

• PostgreSQL

Key Features

• Use Ruby Gems as a software packages system.
• Use database migration files to maintain database schema
• Use data models with associations.
• Use customize model methods
• Use validation for models
• Use controllers to handle requests and render empty views
• Use preprocessed HTML file with embedded Ruby code.
• Use Rails forms to add foods, recipes and ingredients to recipe
• Use devise with authentication
• Use cancancan for user authorization

(back to top)

🚀 Live Demo

• Coming soon

(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: Rails and postgres install on your local computer.

  $ gem install rails

 #postgres for ubuntu: 
  $ sudo apt update
  $ sudo apt install postgresql postgresql-contrib

Setup

Clone this repository to your desired folder:

  https://github.com/gandradep/Recipe_app.git

Install

Install this project with:

  $ bundle install

Usage

To run the project, execute the following command:

  $ rails server

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Gabriel Andrade

• GitHub: @gandradep
• Twitter: @leribagandrade
• LinkedIn: LinkedIn

👤 Josué Benavides

• GitHub: @jdbs9514
• Twitter: @JODA1015
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Create API
• Deploy

(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 do not forget to start the repository.

(back to top)

🙏 Acknowledgments

Microverse for giving this project guides.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)