Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ssekpius/microverse-recipe-app


https://github.com/ssekpius/microverse-recipe-app

Last synced: 19 days ago
JSON representation

Awesome Lists containing this project

README 

        



# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)



# 📖 Recipe App 



**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 



  Client

  



  Server

  



Database

  



### Key Features 



- **Sign-up / Log-in**

- **Create / delete a food, recipe, inventory**

- **Generate shopping list**

- **Make recipe private or public**



(back to top)



## 💻 Getting Started 



To get a local copy up and running, follow these steps.



### Prerequisites



In order to run this project you need:



- Node js installed on your computer

- Npm Node package manager

- Terminal

- Rails installed

- Ruby installed



### Setup



Clone this repository by using the command line :



- `https://github.com/odaialazzeh/Recipe-app.git`



### Install



Install this project with:



```sh

  cd Recipe_App

  bundle install

  rails db:create

  rails db:migrate

```



### Usage



To run the project, execute the following command:



`rails server`



(back to top)



## 👥 Authors 



> Mention all of the collaborators of this project.



👤 **Ahmed Abas**



- GitHub: [@boo-shehab](https://github.com/boo-shehab)

- Twitter: [@boo_shehab2000](https://twitter.com/boo_shehab2000)

- LinkedIn: [boo-shehab](https://www.linkedin.com/in/boo-shehab)



👤 **Odai**



- GitHub: [odai-alazzeh](https://github.com/odaialazzeh)

- Twitter: [@twitterhandle](https://twitter.com/odaialazzeh4)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/odaialazzeh/)



👤 **Riyana Abdi**



- GitHub: [@ibtisam34](https://github.com/ibtisam34)

- LinkedIn: [Falis](https://linkedin.com/in/falis-abdikani/)



(back to top)



## 🔭 Future Features 



- `Meal planning:This feature could help users plan their meals for the week or month, and suggest recipes based on their preferences and dietary restrictions.`

- `Adding nutritional information to recipes could be a valuable feature for users who are concerned about their health and wellbeing. `

- ` A rating and feedback system for recipes would allow users to rate and review recipes they have tried`

- `Social features, such as the ability to follow other users and share recipes with friends`

- `Adding video tutorials to the app could help users learn new cooking techniques`



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



Feel free to check the [issues page](https://github.com/odaialazzeh/Recipe-app/issues).



(back to top)



## ⭐️ Show your support 



If you like this project please give it a star



(back to top)



## 🙏 Acknowledgments 



A list of resources that i find helpful and would like to give credit to :



- [Microverse ](https://www.microverse.org)

- [GitHub ](https://www.github.com)

- [Youtube ](https://www.youtube.com)

- [W3schools ](https://www.w3schools.com)

- [Stackoverflow ](https://stackoverflow.com)

- [Ruby](https://www.ruby-lang.org/en/)

- [Ruby on Rails](https://guides.rubyonrails.org/)



(back to top)



## 📝 License 



This project is [MIT](./MIT.md) licensed.



(back to top)