📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 License
📖 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.
🛠 Built With
Tech Stack
Language
Framwork
Server
Database
Test Library
Key Features
- A login page.
- A registration page.
- A food list (with all CRUD implementation, except for 'update').
- A recipes list (with all CRUD implementation, except for 'update').
- A general shopping list view (all missing food for all your recipes and total price).
- A list of all public recipes from other users with their names and total prices.
🚀 Live Demo
Add a link to your deployed project.
- Live Demo Link comming soon
💻 Getting Started
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:
cd my-folder
git clone git@github.com:megha-n-bodke/recepie-app.git
Install
Install this project with:
cd my-project
gem install
Usage
To run the project, execute the following command:
rails server
Run tests
To run tests, run the following command:
bin/rspec spec
Deployment
You can deploy this project following this instructions: Read
👥 Authors
👤 Lawrence Addai Kusi
- GitHub: @Githubhandle
- Twitter: @Twitterhandle
- Linkedin: Linkedin
👤 Megha Bodke
- GitHub: @megha-n-bodke
- LinkedIn: Megha Bodke
🔭 Future Features
These are features that will be add to the project..
- Creating a data model
- Processing data in models
- Validations and Model specs
- Setup and controllers
- Controllers specs
- Views
- Add forms
- Integration specs for Views and fixing n+1 problems
- Add Devise
- Add authorization rules
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
If you like this project, you can feel free to add or support
🙏 Acknowledgments
I would like to thank Microverse for this insight project
📝 License
This project is MIT licensed.