https://github.com/inspecta/ror-food-recipes
https://github.com/inspecta/ror-food-recipes
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/inspecta/ror-food-recipes
- Owner: inspecta
- License: other
- Created: 2023-02-06T08:45:30.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-02-10T10:20:11.000Z (over 3 years ago)
- Last Synced: 2025-03-14T02:29:16.793Z (over 1 year ago)
- Language: Ruby
- Size: 726 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Food Recipes README
# 📗 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 (OPTIONAL)](#faq)
- [📝 License](#license)
RoR FOOD RECIPES is a Ruby on Rails application that keeps track of all your food and recipes. It allows you to create recipes, foods and also 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
> Describe between 1-3 key features of the application.
- Create, show or delete a food
- Create, display or delete a food recipe
- Display a shopping list
> 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:
- Ruby and rails installed
- PostgreSQL server installed also
### Setup
Clone this repository to your desired folder:
```sh
mkdir blog-app
cd blog-app
git clone https://github.com/inspecta/RoR-Food-Recipes.git
```
### Install
Install this project with:
```sh
cd RoR-Food-Recipes
gem install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
gem install rspec
rspec spec
```
> Mention all of the collaborators of this project.
👤 **Author1**
- GitHub: [@inspecta](https://github.com/inspecta)
- Twitter: [@djmulinde](https://twitter.com/djmulinde)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mulinde-derrick)
👤 **Author2**
- GitHub: [@Joe1-100](https://github.com/Joel-100)
- Twitter: [@Joel Kugonza](https://twitter.com/JoelKugonza)
- LinkedIn: [Joel Kugonza](https://www.linkedin.com/in/joel-kugonza/)
> Describe 1 - 3 features you will add to the project.
- [ ] A better User Interface
- [ ] The inventory functionality
- [ ] A chat functionality for users to communicate with Recipe and Food creators
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, please give it a star.
> Give credit to everyone who inspired your codebase.
I would like to thank Microverse for their continued support. They've provided us with the reading material that have helped us to create this application.
> Add at least 2 questions new developers would ask when they decide to use your project.
- **Can I reuse this code?**
- Yes sure, feel free.
- **Are contributions welcome?**
- Yes please. Contact me at `djmulinde@gmail.com` and I will be happy to add you as a contributor.
This project is [MIT](./LICENSE) licensed.