Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grandi0z/recipe_app
The recipe app is a application that allows users to create, share, and discover recipes
https://github.com/grandi0z/recipe_app
ruby-on-rails
Last synced: about 1 month ago
JSON representation
The recipe app is a application that allows users to create, share, and discover recipes
- Host: GitHub
- URL: https://github.com/grandi0z/recipe_app
- Owner: Grandi0z
- License: mit
- Created: 2023-10-30T09:05:07.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-11-09T15:23:07.000Z (about 1 year ago)
- Last Synced: 2024-05-17T15:25:46.541Z (8 months ago)
- Topics: ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 2.4 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 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)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**Recipe app** application that allows users to create, share, and discover recipes. It has the following features:
- Users can sign up and log in with Devise, a gem that provides user authentication functionality.
Users can create their own recipes with a name, description, ingredients, steps, and a public or private status. They can also edit or delete their recipes if they are the owners.
- Users can view a list of their own recipes or a list of all public recipes created by other users. They can also search for recipes by name or filter them by date.
- Users can view the details of a selected recipe, including the ingredients, steps, and a toggle button that allows them to make the recipe public or private. They can also see the name and email of the recipe owner if the recipe is public.
- Users can create a food list with the name, quantity, and price of the food items they have. They can also edit or delete their food items.
- Users can view a general shopping list that shows the food items that are missing for all their recipes. They can also see the total number of items and the total price of the missing food.
- **Login**
- **View the list own's recipes or a list of all public**
- **View the details of a selected recipe**
- **View a general shopping list**
## Getting Started
### Prerequisites
In order to run this project, you must have installed and configured ruby in your local environment:
You we also need to setup Postgres database
### Setup
Clone this repository to your desired folder:
Before to run the program, verify that you have Ruby installed on your OS running the following command:
### Usage
Run the following command inside the project folder:
1. Open your terminal and navigate to the root directory of your project.
2. Run ```bundle install``` to install the required gems.
3. Run ```rails db:create``` and ```rails db:migrate``` to create and set up the database.
4. `rails server` to start the app on `http://localhost:3000`.
5. open your navigator
6. Go to ```http://localhost:3000/```
7. Enjoy
### Run tests
Before running tests, ensure you've set up the test database:
```sh
bin/rails db:migrate RAILS_ENV=test
```
```sh
bundle exec rspec ./spec
```
For linters test :
```$
rubocop
```
```$
npx stylelint "**/*.{css,scss}"
```
### Deployment
You can deploy this project using: GitHub Pages Netifly or Render
👤 **Joseph L Kausi**
- GitHub: [@Grandi0z](https://github.com/Grandi0z)
- Twitter: [@Joseph_LSK](https://twitter.com/Joseph_LSK)
- LinkedIn: [Joseph L Kausi](https://www.linkedin.com/in/joskal/)
- [ ] **Add API endpoint**
- [ ] **Create a mobile app**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Grandi0z/Recipe_app/issues).
If you like this project, I would like to Thank You!
Special Thanks to the Microverse and Micronauts.
This project is [MIT](https://github.com/Grandi0z/Recipe_app/blob/dev/LICENSE) licensed.