Recipe App
📗 Table of Contents
- 📖 About the Project
- Diagram
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
Recipe App
Recipe App keeps track of all your recipes and ingredients. 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
Server
Key Features
- A login page
- A registration page
- A food list
- A recipes list
- A general shopping list view
- A list of public recipes
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
- Ruby
- Rails
- Postgresql
Setup
Clone this repository to your desired folder:
cd RECIPE-APP
git clone https://github.com/Abe1able/Recipe-App.git
Install
Install this project with:
- After cloning type 'cd blog-app'.
- Run 'bundle install' to install all the required dependencies.
Usage
To run the project, execute the following command:
- Run 'rails db:create' to create a new database
- Run 'rails db:migrate' to migrate the db and build the schema
- Run 'rails s' to start the dev server
👥 Authors
👤 Saba Ahmad
- GitHub: @SabaAhmad404
- LinkedIn: Saba Ahmad
👤 Abel Seifu
🔭 Future Features
Features to add to the project.
- Pagination or infinite scrolling for the lists.
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
If you like this project...
❓ FAQ
-
Do I have to have any previous knowledge about ruby to use this project?
- No!
-
How to use this project?
- check the Getting Started section to have a complete guid on how to setup and run teh project.
📝 License
This project is MIT licensed.