https://github.com/nitbravoa92/recipe-app
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.
https://github.com/nitbravoa92/recipe-app
cancancan capybara devise rspec-rails ruby-on-rails
Last synced: about 1 month ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/nitbravoa92/recipe-app
- Owner: NitBravoA92
- License: mit
- Created: 2023-10-08T18:55:44.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-10-15T02:04:18.000Z (almost 2 years ago)
- Last Synced: 2025-01-13T14:59:14.512Z (9 months ago)
- Topics: cancancan, capybara, devise, rspec-rails, ruby-on-rails
- Language: Ruby
- Homepage: https://recipe-app-zxdn.onrender.com/
- Size: 3.79 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe App | Ruby on Rails
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Recipe App ](#-recipe-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Usage](#usage)
- [Install](#install)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
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.
### 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.
To see the application working live, you can click on the following link that contains the demo version:
- [easyCOOK - Live Demo](https://recipe-app-zxdn.onrender.com/)
### 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
```
### Usage
To open a local server, type the following command:
```
rails server
```
### 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
```
### Run tests
To run the RSpec unit and integration tests, use the following command:
```
rspec
```
👤 **Nitcelis Bravo**
- GitHub: [Nitcelis Bravo](https://github.com/NitBravoA92)
- Twitter: [@softwareDevOne](https://twitter.com/softwareDevOne)
- LinkedIn: [Nitcelis Bravo Alcala](https://www.linkedin.com/in/nitcelis-bravo-alcala-b65340158)
👤 **Manuel Sánchez**
- GitHub: [@Luffytaro22](https://github.com/Luffytaro22)
- LinkedIn: [Manuel Sánchez](https://www.linkedin.com/in/manuel-alejandro-sanchez-sierra/)
## 🔭 Future Features
- [ ] Allow the users to follow each other.
- [ ] Implement a like button to the recipes.
- [ ] Generate API endpoints.
- [ ] Deploy the application.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## ⭐️ Show your support
If you like this project please give it a star ⭐️
I would like to give credits to the following:
* **Microverse** for this readme template.
This project is [MIT](./LICENSE) licensed.