Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahzamir/food-recipes-app
The Food Recipes App keeps track of all your recipes, ingredients. 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 allows you to make them public so anyone can access them.
https://github.com/ahzamir/food-recipes-app
cancancan capybara css devise rspec rubocop ruby ruby-gem ruby-on-rails
Last synced: 25 days ago
JSON representation
The Food Recipes App keeps track of all your recipes, ingredients. 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 allows you to make them public so anyone can access them.
- Host: GitHub
- URL: https://github.com/ahzamir/food-recipes-app
- Owner: ahzamir
- Created: 2022-09-12T13:08:03.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-03-31T18:58:29.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T07:58:52.019Z (3 months ago)
- Topics: cancancan, capybara, css, devise, rspec, rubocop, ruby, ruby-gem, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 1.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Food Recipes App
> The Food Recipes App keeps track of all your recipes, ingredients. 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 allows you to make them public so anyone can access them.
## Schema
## Built With
- [x] Programming Language: [Ruby](https://www.ruby-lang.org/en/)
- [x] Framework: [Ruby on Rails](https://rubyonrails.org/)
- [x] Linter: [Rubocop](https://rubocop.org/)
- [x] Code Editor: [VS Code](https://code.visualstudio.com/)
- [x] Database: [PostgreSQL](https://www.postgresql.org/)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Install
In the terminal, go to your file directory and run this command.
```
$ git clone https://github.com/ahzamir/food-recipes-app.git
```
### Usage
```
$ cd blog-app
```
```
$ rails server
```
### Setup
```
$ bundle install
```
```
$ rubocop .
```
### Run tests
To install rspec, in the terminal kindly run this command
```
$ gem install rspec
```
To run tests, please run this command
```
$ rspec ./spec/#{filename}_spec.rb
```
### API Documentation
Ypu can find the API documentation by:
```
$ rails server
```
Then go to this link: [http://localhost:3000/api-docs/index.html](http://localhost:3000/api-docs/index.html)
### Prerequisites
- [x] A web browser like [Google Chrome](https://www.google.com/chrome/).
- [x] A code editor like [Visual Studio Code](https://code.visualstudio.com/).
- [x] A terminal to run the code.
- [x] [Ruby](https://www.ruby-lang.org/en/) installed on your computer.
- [x] [Rails](https://rubyonrails.org/) installed on your computer.
You can check if Git is installed by running the following command in the terminal.
```
$ git --version
```
Likewise for Ruby installation.
```
$ ruby --version && irb
```
To install rails, in the terminal kindly run this command
```
$ gem install rails
```
## Authors
👤 **Ahmad Zamir Yousufi** 
- GitHub: [@ahzamir](https://github.com/ahzamir).
- Twitter: [@YousufiZamir](https://twitter.com/YousufiZamir)
- LinkedIn: [ahmad-zamir-yousufi](https://www.linkedin.com/in/ahzamir/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/ahzamir/food-recipes-app/issues).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- [Microverse](https://www.microverse.org/)
- Code Reviewers
- Coding Partners
## 📝 License
This project is [MIT](./MIT.md) licensed.
