https://github.com/chrissiku/recipe-app
A web that help you to keep track and save recipes, ihelpsngredients, and inventory
https://github.com/chrissiku/recipe-app
bootstrap5 cancancan devise letter-opener ruby-on-rails
Last synced: 3 months ago
JSON representation
A web that help you to keep track and save recipes, ihelpsngredients, and inventory
- Host: GitHub
- URL: https://github.com/chrissiku/recipe-app
- Owner: Chrissiku
- Created: 2022-10-03T11:05:56.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-09T15:00:56.000Z (over 2 years ago)
- Last Synced: 2025-02-28T05:47:40.016Z (3 months ago)
- Topics: bootstrap5, cancancan, devise, letter-opener, ruby-on-rails
- Language: Ruby
- Homepage: https://infinite-ravine-36732.herokuapp.com/
- Size: 135 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Recipe_App
> The 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.
## Built With
- Major: Ruby, HTML,CSS
- Frameworks: `Rails`, `Bootstrap5`
- Libraries: `Cancancan`, `Devise`
- Technologies: Git, Gitflow, Linters, Github, PostgreSql, Rspec, Capybara, Robocop
## Live Demo
[Live Demo Link](https://infinite-ravine-36732.herokuapp.com/)
## Sing_up and Login instructions
- After you create you new account go back to the login button then you could be able to login
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
- Have a computer and internet connection
- Have `Ruby` installed on your computer
- Have `Rails` installed on your computer
- Have a basic knowledge of `Ruby` and `OOP` concept
- Have a basic knowledge of `Rails`
- Have a general understanding of what testing is
- Have `visual-studio code` or any other code editor installed on your computer.
### Setup
- In order to get a copy of this project you need to download it from https://github.com/Chrissiku/Recipe-app/
- Extract the zipped file and open it in your code editor
### Install
- Run the command bellow in your terminal to get all required files
```
bundle install
```
```
npm install
```
### Run tests
you can run one of the following command in your terminal
1. Run testing
```Ruby
rspec spec
```
2. Run linters
```Ruby
> npx stylelint "**/*.{css,scss}"
> Rubocop --color
> Rubocop -A
```
## Authors
👤 **Abdo**
- GitHub: [@githubhandle](https://github.com/Abdo9826
)
👤 **Chris Siku**
- GitHub: [@githubhandle](https://github.com/Chrissiku)
- Twitter: [@twitterhandle](https://twitter.com/christian_siku)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/christian-siku/)
👤 **Safar Ali**
- GitHub: [@githubhandle](https://github.com/safar1212)
- Twitter: [@twitterhandle](https://twitter.com/SafarAli999
)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/safar-ali999/
)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!