https://github.com/techemprez/my-recipe
A food recipe app
https://github.com/techemprez/my-recipe
Last synced: about 1 month ago
JSON representation
A food recipe app
- Host: GitHub
- URL: https://github.com/techemprez/my-recipe
- Owner: techEmprez
- License: mit
- Created: 2023-05-23T08:20:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-29T21:47:24.000Z (almost 2 years ago)
- Last Synced: 2025-02-13T04:44:35.368Z (3 months ago)
- Language: Ruby
- Size: 10.5 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)
- [📝 License](#license)
> The CookPad 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
> Here are List of technologies used on this project
Languages
Framework
Database
Linters
Test library
- Create recipes
- Generate a user custom shopping list.
- Keeps track of all your recipes, ingredients, and inventory.
### Prerequisites
In order to run this project you need:
- Ruby installed on your computer
### Setup
Clone this repository to your desired folder:
```
git clone https://github.com/techEmprez/My-Recipe.git
```
change directory to cloned folder
```
cd My-Recipe
```
### Install
Install project dependecies with:
```
bundle install
```
-
### Usage
To run the project, execute the following command:
```
rails server
```
- After running `rails server`, open your browser and enter this address http://localhost:3000/
- Congratulations! your're running **_My-Recipe_**
👤 **Choice Osobor**
- GitHub: [@techempress](https://github.com/techempress)
- Twitter: [choice](https://twitter.com/choice)
- LinkedIn: [choice](https://www.linkedin.com/in/choice/)
👤 **Emmanuel Simasiku**
- Github: [Mukumbuta](https://github.com/Mukumbuta)
- Twitter: [mukumbuta8](https://twitter.com/mukumbuta8)
- LinkedIn: [Mukumbuta](https://www.linkedin.com/in/Mukumbuta/)
> These features will be added in future updates. ⬇️⬇️
- [ ] **Controllers specs**
- [ ] **Processing data in models**
- [ ] **Add api endpoint for generating recipes**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like👍🏽 this project, give the repository a star ⭐
I would like to thank the Microverse community
This project is [MIT](./LICENSE) licensed.