Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/binhussen/recipe-app
https://github.com/binhussen/recipe-app
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/binhussen/recipe-app
- Owner: binhussen
- Created: 2022-12-19T12:23:15.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-24T20:45:30.000Z (about 2 years ago)
- Last Synced: 2024-11-01T12:11:55.644Z (2 months ago)
- Language: Ruby
- Size: 13.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[ Food Recipe\] ](#--food-recipe-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
> 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.
Client
Server
Database
- **food list**
- **recipe List**
- **general shopping**
- [Live demo](https://recipe-app-y24d.onrender.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/binhussen/recipe-app.git
```
```sh
cd recipe-app
```
### Install
Install this project with:
```sh
bundle install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
bin/rails test
```
### Deployment
You can deploy this project using:
👤 **Mohammed Hussen (binhussen)**
- GitHub: [@binhussen](https://github.com/binhussen)
- Twitter: [@binhussens](https://twitter.com/binhussens)
- LinkedIn: [Linkedin](https://www.linkedin.com/in/binhussen/)
👤 **Summyalena**
- GitHub: [@summyalena](https://github.com/githubhandle)
- Twitter: [@AOkolike](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
- [ ] **A food list**
- [ ] **A recipes list**
- [ ] **A general shopping list view**
- [ ] **A list of all public recipes from other users with their names and total prices.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project...
I would like to thank
- Microverse
- Code Reviewers
- **[Question_1]**
- [Answer_1]
- **[Question_2]**
- [Answer_2]
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._