Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itsmraga-hub/recipe-app
https://github.com/itsmraga-hub/recipe-app
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/itsmraga-hub/recipe-app
- Owner: itsmraga-hub
- License: mit
- Created: 2022-12-12T07:58:31.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-12-18T09:27:06.000Z (almost 2 years ago)
- Last Synced: 2024-04-17T01:44:52.597Z (6 months ago)
- Language: Ruby
- Size: 646 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe app
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 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](#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.
**[Recipe app]** is a recipe manager website.
> Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server | Backend
Database
> Describe between 1-3 key features of the application.
- **[Delete added items]**
- Delete and update items in the app.
- **[Add Recipes, Foods and Ingredients]**
- Interact with recipes, foods and recipe foods.
- **[Sign in and sign up]**
- User authentication. Set recipe to either public or private.
> Add a link to your deployed project.
- [Live Demo Link coming soon](https://yourdeployedapplicationlink.com)
> 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:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
```sh
cd recipe-app
git clone https://github.com/itsmraga-hub/recipe-app.git
cd recipe-app
Open in your favorite editor
```
### Install
Install this project with:
```sh
cd recipe-app
gem install
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/rspec spec
```
### Deployment
You can deploy this project using:
> Mention all of the collaborators of this project.
👤 **William Raga**
- GitHub: [@itsmraga-hub](https://github.com/itsmraga-hub)
- Twitter: [@RagaMacharia](https://twitter.com/RagaMacharia)
- LinkedIn: [William Raga](https://linkedin.com/in/itsmraga)
👤 **Yunus Ali**
- GitHub: [@IamYunusALi](https://github.com/iamyunusali)
- Twitter: [@IamYunusAli](https://twitter.com/iamyunusali)
- LinkedIn: [Yunus Ali](https://linkedin.com/in/iamyunusali)
> Describe 1 - 3 features you will add to the project.
- [ ] **[Inventory]**
- [ ] **[Inventory details]**
- [ ] **[Inventory Shopping List]**
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...
> Give credit to everyone who inspired your codebase.
I would like to thank...
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Question_1]**
- [Answer_1]
- **[Question_2]**
- [Answer_2]
This project is [MIT](./LICENSE) licensed.