RECIPE App
📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
📖 [Blog-App]
Describe your project in 1 or 2 sentences.
[RECIPE-App] This 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.
🛠 Built With
Tech Stack
Ruby Rails Postgresql
Client
Key Features
Describe between 1-3 key features of the application.
- [Create a new User]
- [Add a food Item]
- [Create a recipe]
💻 Getting Started
Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
- gem install rails
Setup
Clone this repository to your desired folder:
Install
Install this project with:
- bundle install
Usage
To run the project, execute the following command:
- rails server
Run tests
To run tests, run the following command:
- rspec
Deployment
You can deploy this project using:
- github pages
- netlify
👥 Authors
Mention all of the collaborators of this project.
👤 John Mutisya
- GitHub: @John Mutisya
- Twitter: @John Mutisya
- LinkedIn: John Mutisya
👤 Daphine Atim
- GitHub: @Daphineatim
- Twitter: @dhaphyn
- LinkedIn: DaphineAtim
🔭 Future Features
Describe 1 - 3 features you will add to the project.
- [Showing Recipes to the public]
- [Authentication and Authorization of Users]
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
Write a message to encourage readers to support your project
If you like this project...
🙏 Acknowledgments
Give credit to everyone who inspired your codebase.
I would like to thank...
❓ FAQ
Add at least 2 questions new developers would ask when they decide to use your project.
-
[What is the main objective of this branch?]
- [Construction of different classes using RUBY]
-
[What is the symbol for class inheritance]
- ["<" sign. on the left hand side the derived class name will appear and the parent classname will be placed on the right hand side.]
📝 License
This project is MIT licensed.