- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ (OPTIONAL)
- 📝 License
RoR FOOD RECIPES is a Ruby on Rails application that keeps track of all your food and recipes. It allows you to create recipes, foods and also 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.
Client
Server
Database
Describe between 1-3 key features of the application.
- Create, show or delete a food
- Create, display or delete a food recipe
- Display a shopping list
Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
In order to run this project you need:
- Ruby and rails installed
- PostgreSQL server installed also
Clone this repository to your desired folder:
mkdir blog-app
cd blog-app
git clone https://github.com/inspecta/RoR-Food-Recipes.git
Install this project with:
cd RoR-Food-Recipes
gem install
To run the project, execute the following command:
rails server
To run tests, run the following command:
gem install rspec
rspec spec
Mention all of the collaborators of this project.
👤 Author1
- GitHub: @inspecta
- Twitter: @djmulinde
- LinkedIn: LinkedIn
👤 Author2
- GitHub: @Joe1-100
- Twitter: @Joel Kugonza
- LinkedIn: Joel Kugonza
Describe 1 - 3 features you will add to the project.
- A better User Interface
- The inventory functionality
- A chat functionality for users to communicate with Recipe and Food creators
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Write a message to encourage readers to support your project
If you like this project, please give it a star.
Give credit to everyone who inspired your codebase.
I would like to thank Microverse for their continued support. They've provided us with the reading material that have helped us to create this application.
Add at least 2 questions new developers would ask when they decide to use your project.
-
Can I reuse this code?
- Yes sure, feel free.
-
Are contributions welcome?
- Yes please. Contact me at
djmulinde@gmail.com
and I will be happy to add you as a contributor.
- Yes please. Contact me at
This project is MIT licensed.