Microverse README Template
📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ (OPTIONAL)
- 📝 License
📖 [Recipe_app]
Describe your project in 1 or 2 sentences.
[Recipe_app] is is a web application that allows user to keep track of all recipes, ingredients, and make inventory
🛠 Built With
Tech Stack
Client
- HTML, CSS
- JavaScript
Server
- Ruby on Rails
Database
Key Features
- [Create and run necessary migration files]
- [Match table and column names to the ERD diagram.]
💻 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:
Setup
Clone this repository to your desired folder:
git clone https://github.com/tarikbouari/Recipe_app.git
Install
Then install the project's necessary dependencies with:
bundle install
Usage
To run the project, execute the following command:
rails server
Run tests
To run tests, run the following command:
bin/rails rspec spec/
👥 Authors
Mention all of the collaborators of this project.
👤 Tarik Bouari
- GitHub: @tarikbouari
- Twitter: @tarikbouari
- LinkedIn: tarikbouari
🔭 Future Features
Describe 1 - 3 features you will add to the project.
- Adding controllers
- Adding views
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
Give this project a ⭐️ if you like it!
🙏 Acknowledgments
I would like to thank:
And Shout out to the Ruby documentation :)
📝 License
This project is MIT licensed.