Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nickemma/recipe-app
This is a Ruby on Rails 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
https://github.com/nickemma/recipe-app
capybara css3 database gitflow postgresql rspec-testing ruby ruby-on-rails
Last synced: about 1 month ago
JSON representation
This is a Ruby on Rails 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
- Host: GitHub
- URL: https://github.com/nickemma/recipe-app
- Owner: nickemma
- License: mit
- Created: 2022-11-07T07:17:25.000Z (over 2 years ago)
- Default Branch: development
- Last Pushed: 2022-11-14T14:45:06.000Z (over 2 years ago)
- Last Synced: 2024-12-16T20:32:35.321Z (2 months ago)
- Topics: capybara, css3, database, gitflow, postgresql, rspec-testing, ruby, ruby-on-rails
- Language: Ruby
- Homepage: https://young-ravine-31046.herokuapp.com/users/sign_in
- Size: 186 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Name
My Recipe App
# Description the project.
This is a Ruby on Rails 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.
## Built With
- Languages:
_**Ruby**_
_**Postgresql**_
- Frameworks: _**Ruby On Rails**_
- Technologies used: _**Visual Studio Code**_
### 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/)
## Getting Started
### Clone this repository
```bash
$ git clone [email protected]:NickEmma/recipe-app.git
$ cd 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 "**/*.{css,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 TailwindCSS for the styling, you need to run:
```bash
$ ./bin/dev
```
For you to see the styling being applied in the browser during development
## Authors
👤 **Nicholas Emmanuel**
- GitHub: [@NickEmma](https://github.com/NickEmma)
- Twitter: [@techieEmma](https://twitter.com/techieEmma)
- LinkedIn: [@Nicholas Emmanuel](https://www.linkedin.com/in/techieemma/)
## 🤝 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!
## Acknowledgments
- Microverse
- LazyCoders
- Coding Partners
- Inspiration
- etc
## 📝 License
This project is [MIT](./LICENSE) licensed.