Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graujavier/recipe-app
https://github.com/graujavier/recipe-app
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/graujavier/recipe-app
- Owner: grauJavier
- Created: 2023-10-09T17:01:49.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-10-14T13:21:38.000Z (about 1 year ago)
- Last Synced: 2023-10-16T00:20:50.938Z (about 1 year ago)
- Language: Ruby
- Size: 343 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Recipe App | Ruby on Rails Capstone Project
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
---
**"Recipe app"** keeps track of all your recipes, ingredients, and inventory. It will allow 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. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.
These is the ERD for the project:
---
### Tech Stack
The project is built using the following technologies:
* Ruby on Rails.
* PostgreSQL.
* RSpec.
* Rubocop.
* Stylelint.
---
- [x] Create and delete recipes and ingredients.
- [x] 'Make public' option to share recipes with other users.
- [x] User authentication.
- [x] Responsive design.
Please note: Each feature will be marked with an "x" when it is fully implemented and operational.
- HTML & CSS3
- Ruby on Rails
- Linters
- Rubocop
- StyleLint
- Follow Microverse's list of best practices
---
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need to have:
- Installed Ruby and Ruby on Rails.
- 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 https://github.com/grauJavier/recipe-app.git
```
Navigate to the cloned repository and run the following command to install the necessary gems:
```
cd blog-app
bundle install
```
### Usage
Initialize it with
```
rails server
```
Then open `http://localhost:3000` in your browser.
### Test
To run the tests try the following command:
```
rspec spec
```
---
👤 **Javier Grau**
- GitHub: [@grauJavier](https://github.com/grauJavier)
- Twitter: [@jgrauchile](https://twitter.com/jgrauchile)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/javiergrau)
👤 **Ruth Abreu**
- GitHub: [@Ruthmy](https://github.com/Ruthmy)
- Twitter: [@rury_exe](https://twitter.com/rury_exe)
- LinkedIn: [LinkedIn](https://linkedin.com/in/ruth-abreu)
---
Upcoming improvements:
- [ ] Search functionality for locating specific articles.
- [ ] User profiles with customizable avatars.
---
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/grauJavier/recipe-app/issues).
---
If you like this project and know someone who might find it helpful, please share it.
Or give it a **star** ⭐️
---
I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.
---
This project is [MIT](./LICENSE) licensed.
---