Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnftitor/my_recipe_app
This is a simple Ruby On Rails project. Recipe app that allows user to create, delete, and read recipes created by them or the community, allowing the users to decide whether they'd be public or not. Additionally, it allows users to create food records and generate a shopping list based on the missing food for their recipes. It comes with authentication and authorization functionality.
https://github.com/johnftitor/my_recipe_app
bootstrap database postgresql rails ruby
Last synced: 14 days ago
JSON representation
This is a simple Ruby On Rails project. Recipe app that allows user to create, delete, and read recipes created by them or the community, allowing the users to decide whether they'd be public or not. Additionally, it allows users to create food records and generate a shopping list based on the missing food for their recipes. It comes with authentication and authorization functionality.
- Host: GitHub
- URL: https://github.com/johnftitor/my_recipe_app
- Owner: JohnFTitor
- Created: 2022-05-16T15:42:02.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-09-10T18:19:44.000Z (about 1 year ago)
- Last Synced: 2023-09-10T19:33:38.191Z (about 1 year ago)
- Topics: bootstrap, database, postgresql, rails, ruby
- Language: Ruby
- Homepage:
- Size: 12.5 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## My Recipe App
> This is a simple Ruby On Rails project. Recipe app that allows user to create, delete, and read recipes created by them or the community, allowing the users to decide whether they'd be public or not. Additionally, it allows users to create food records and generate a shopping list based on the missing food for their recipes. It comes with authentication and authorization functionality.
## Preview
The complete website for every masterchef! Keep track of your recipes for the best plates worldwide alongside the community. Create, delete and modify your Recipes, don't want to share it? It's a shame but we respect that! Decide whether it'll be public or not. Finally, want to see how much would it cost to make your dishes a reality? No problem! Generate a shopping list of all your recipes by clicking one button. It has never been that easy!
### Requirements
In order to work on this project, you need to have the following dependencies installed:
- [Ruby](https://www.ruby-lang.org/en/)
- [Postgresql](https://www.postgresql.org/)
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/)
- [Rails](https://rubyonrails.org/)
## Built With
- Languages: _**Ruby 3.1.1**_
- Frameworks: _**Ruby On Rails**_, _**Bootstrap**_
- Technologies used: _**Visual Studio Code**_
## Getting Started
### Clone this repository
```bash
$ git clone [email protected]:JohnFTitor/my_recipe_app.git
$ cd my_recipe_app
```
### Commands to run
Run
```bash
$ bundle install
```
To get all the gems required for the project
Then, run
```bash
$ npm install
```
To install packages such as style linters
To check linters locally, use
```bash
$ rubocop
$ npx stylelint "**/*.scss"
```
Once you have the project correctly set up, run
```bash
$ bin/rails db:setup
```
To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes
Finally, each time you make changes to the project, run
```bash
$ bundle exec rspec /spec
```
In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description.
Important note: Since this project uses Bootstrap for the styling, you need to run:
```bash
$ ./bin/dev
```
For you to see the styling being applied in the browser during development
## Authors
:bust_in_silhouette: **Andrés Felipe Arroyave Naranjo**
Platform | Badge |
--- | --- |
**GitHub** | [@JohnFTitor](https://github.com/JohnFTitor)
**Twitter** | [@johnftitor](https://twitter.com/johnftitor)
**LinkedIn** | [Andres](https://www.linkedin.com/in/andresarroyavenaranjo/?locale=en_US)
👤 **ALeonardoAlbornozA**
Platform | Badge |
--- | --- |
**GitHub**: | [@Leboroz](https://github.com/leboroz)
**Twitter**: | [@Leboroz](https://twitter.com/leboroz)
**LinkedIn**: | [Leonardo Albornoz](https://linkedin.com/in/linkedinhandle)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
## Show your support
Give a ⭐️ if you like this project!