Skip to content

The RecipeApp is a web application build on Ruby on Rails and TailwindCSS 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.

License

Notifications You must be signed in to change notification settings

NitBravoA92/recipe-app

Repository files navigation

Recipe App | Ruby on Rails

📗 Table of Contents

📖 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
Front-end

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:

(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

👤 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)

About

The RecipeApp is a web application build on Ruby on Rails and TailwindCSS 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.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published