Recipe App | Ruby on Rails

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Usage
    • Install
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Recipe App

The Recipe App is a web application build on Ruby on Rails that allows 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

Tech Stack

Back-end

• Ruby on Rails (v 7.0.8)
• PostgreSQL

Front-end

• HTML5
• CSS3
• ERB template
• JavaScript

Key Features

• Use of Rails framework.
• MVC architecture.
• Save and retrieve information from a PostgreSQL database.
• Log in and registration with Devise gem.
• Integration and unit tests with Capybara and RSpec.
• Authorization with CanCanCan gem.
• Find and solve N + 1 problems with Bullet gem.

(back to top)

🚀 Live Demo

To see the application working live, you can click on the following link that contains the demo version:

• easyCOOK - Live Demo

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need to have:

• Installed Ruby (v 3.2.2).
• Installed PostgreSQL.
• 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 git@github.com:NitBravoA92/recipe-app.git

(back to top)

Usage

To open a local server, type the following command:

rails server

(back to top)

Install

To install all the ruby gems, use the following command:

bundle install

To install the npm dependencies, use the following command:

npm install

After installing the gems, run this command to create and migrate a database:

rails db:create db:migrate

(back to top)

Run tests

To run the RSpec unit and integration tests, use the following command:

rspec

(back to top)

👥 Authors

👤 Nitcelis Bravo

• GitHub: Nitcelis Bravo
• Twitter: @softwareDevOne
• LinkedIn: Nitcelis Bravo Alcala

👤 Manuel Sánchez

• GitHub: @Luffytaro22
• LinkedIn: Manuel Sánchez

(back to top)

🔭 Future Features

• Allow the users to follow each other.
• Implement a like button to the recipes.
• Generate API endpoints.
• Deploy the application.

(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 give credits to the following:

• Microverse for this readme template.

(back to top)

📝 License

This project is MIT licensed.

(back to top)