https://github.com/tsheporamantso/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.
https://github.com/tsheporamantso/recipe-app
postgresql rspec ruby-on-rails
Last synced: 3 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/tsheporamantso/recipe-app
- Owner: tsheporamantso
- License: mit
- Created: 2024-02-05T06:25:30.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-02-15T13:04:50.000Z (over 1 year ago)
- Last Synced: 2025-01-26T19:28:22.709Z (5 months ago)
- Topics: postgresql, rspec, ruby-on-rails
- Language: Ruby
- Homepage: https://recipeapp-sxaw.onrender.com
- Size: 435 KB
- Stars: 1
- 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)
- [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](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**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.
- **Ruby on Rails**
- **Ruby**
- **HTML**
- **CSS**
Server
- **Ruby on Rails**
- **Creating data model**
- **Functional website**
- **Database**
- **Unit Testing**
- Not live yet
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Install ruby using [link](https://www.ruby-lang.org/en/documentation/installation/#apt)
- Install ruby on rails using [link](https://guides.rubyonrails.org/)
### Setup
Clone this repository to your desired folder:
```sh
mkdir Recipe-App
cd Recipe-App
git clone [email protected]:tsheporamantso/Recipe-App.git
```
### Install
Install this project with:
```sh
gem factory_bot_rails
```
```sh
gem rspec-rails
```
```sh
bundle install
```
```sh
rails generate rspec:install
```
```sh
rails db:migrate
```
### Usage
To run the project, execute the following command:
run the result on the terminal through:
```sh
rails server
```
### Run tests
To run tests, execute the following command on the terminal
```sh
bundle exec rspec
```
### Deployment
Not deployed
👤 **Gladwin Tshepo Ramantso**
- GitHub: [@tsheporamantso](https://github.com/tsheporamantso)
- Twitter: [@ramgt001](https://twitter.com/ramgt001)
- LinkedIn: [Tshepo Gladwin Ramantso](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/)
👤 **Fombi Favour**
- GitHub: [Fombi-Favour](https://github.com/Fombi-Favour)
- LinkedIn: [Fombi Favour](https://www.linkedin.com/in/fombi-favour/)
- [ ] **Validation and Model specs**
- [ ] **Processing data in models**
- [ ] **Controllers**
- [ ] **Controllers specs**
- [ ] **Views**
- [ ] **Forms**
- [ ] **Intergration specs for Views and fixing n+1 problems**
- [ ] **Add Devices**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/tsheporamantso/Recipe-App/issues).
If you like this project please give a star on [github](https://github.com/tsheporamantso/OOP-School-Library) & follow us on [twitter](https://twitter.com/ramgt001) and also connect on [Linkedin](https://www.linkedin.com/in/tshepo-ramantso-b6a35433/).
I would like to thank:
- [ ] **Microverse and all the staff**
- [ ] **Microverse Communinity**
- [ ] **Thanks to my coding Partners**
- [ ] **Thanks to my Morning-Session-Group and Standup-Team Partners and**
- [ ] **Thanks to Code Reviewers**
This project is [MIT](./LICENSE) licensed.