https://github.com/torobucci/recipe_app
Recipe App is a web application that enables users to create, share, and explore recipes. Users can effortlessly create their own recipes, including detailed ingredient lists, step-by-step instructions, and cooking times. Recipes can be marked as public or private and shopping list can be generated.
https://github.com/torobucci/recipe_app
Last synced: 7 months ago
JSON representation
Recipe App is a web application that enables users to create, share, and explore recipes. Users can effortlessly create their own recipes, including detailed ingredient lists, step-by-step instructions, and cooking times. Recipes can be marked as public or private and shopping list can be generated.
- Host: GitHub
- URL: https://github.com/torobucci/recipe_app
- Owner: torobucci
- Created: 2023-07-03T08:02:41.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-07-08T15:16:19.000Z (about 2 years ago)
- Last Synced: 2024-12-19T20:51:37.776Z (7 months ago)
- Language: Ruby
- Homepage:
- Size: 159 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
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)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
Recipe App is a web application that enables users to create, share, and explore recipes. Users can effortlessly create their own recipes, including detailed ingredient lists, step-by-step instructions, and cooking times. Recipes can be marked as public or private and shopping list can be generated.
Project language
FrameWork
DataBase
- **log in**
- **Sign in**
- **Display user and public recipes**
- **Add Food**
- **Generate Shopping list.**
- **Make recipe public or private feature**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby installed in your machine
- Ruby on Rails installed in your machine
- Postgres installed and all password and user being setup
- A code editor e.g Vs Code
- Any integrated terminal e.g powershell
### Setup
Clone this repository to your desired folder:
```
cd my-folder
git clone https://github.com/torobucci/Recipe_app.git
```
Don't forget to change UserName and Password with yours in [database.yml](./config/database.yml) file
### Install
Install this project with:
```
bundle install
npm install
```
### Usage
To run the project, execute the following command :
```
rails s
```
### Run tests
To run tests, run the following command:
```
rspec spec
rubocop . //=> for ruby file linting
npx stylelint "**/*.{css,scss}" //=> for CSS or SASS file linting
```
👤 **Kevin Toro**
- GitHub: [@torobucii](https://github.com/torobucci)
- Twitter: [@torobucii](https://twitter.com/@torobucii)
- LinkedIn: [Kevin Toro](https://www.linkedin.com/in/kevin-toro-047181238/)
👤 **David-Lanzz**
- GitHub: [@githubhandle](https://github.com/David-Lanzz/)
- Twitter: [@twitterhandle](https://twitter.com/LanzzDavid)
- LinkedIn: [LinkedIn](https://linkedin.com/in/david-lanzz)
- [ ] **Styling of various webpage**
- [ ] **Create recipes**
- [ ] **Generate shopping list for a particular recipe**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project give this repo a star and reach out on our social media, and we will be happy to know about it! 😃
We would like to thank the Microverse team for their invaluable resources.
This project is [MIT](https://github.com/torobucci/My-Portfolio/blob/main/MIT-LICENSE.txt) licensed.