Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaylemba/receipe-app
https://github.com/kaylemba/receipe-app
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kaylemba/receipe-app
- Owner: KayLemba
- License: mit
- Created: 2022-04-18T08:52:20.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2022-04-22T17:24:55.000Z (almost 3 years ago)
- Last Synced: 2025-01-03T12:53:05.416Z (24 days ago)
- Language: Ruby
- Size: 5.45 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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.
# Getting Started
_To get a local copy up and running follow these simple steps._
1. Clone the repo
```sh
git clone https://github.com/your_username_/Project-Name.git
```
2. Goto project directory
```sh
cd recipe-app
```
3. Configure `database.yml` in the config folder according to your postgreSQL configuration
4. Run app
```sh
rails server
```
or
```sh
rails s
```
# Testing
`bundle exec rspec` will run all the tests.
Also, you can run `bundle exec rspec spec/` to run specific tests.
You can also run `RAILS_ENV=test rspec spec/` to run the tests in test mode.
## Errors
If you encounter any errors, run the following commands.
- Run `rails db:drop db:create db:migrate` to drop, create and migrate a new database.
- Run `rubocop && rubocop -A` to check for and fix code errors.
# This project was built with
- Ruby on Rails
- PostgreSQL
- Bootstrap CSS Framework
# Authors
👤 **Kalolo Chola Lemba**
- GitHub: [@KayLemba](https://github.com/KayLemba)
- Twitter: [@King-Kaylo1](https://twitter.com/King_Kaylo1)
- LinkedIn: [@kalolo-lemba](https://www.linkedin.com/in/https://www.linkedin.com/in/kalolo-lemba)
👤 **Charles Gobina**
- Github:https://github.com/charlesgobina
- Twitter:https://twitter.com/i4mCloud
- LinkedIn:https://www.linkedin.com/in/charles-gobina-74a0ab193/
# 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Donard97/recipe-app/issues).
# Show your support
Give a ⭐️ if you like this project!
# Acknowledgement
- Hat tip to anyone whose code was a source of inspiration.
- A big thanks to [@microverseinc](https://github.com/microverseinc).
# 📝 License
This project is [MIT](./MIT.md) licensed.