https://github.com/secret-super-star/recipe-app
The Recipe app keeps track of all your foods, recipes, and ingredients. It allows 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. Since sharing recipes is an important part, it allows you to make them public so anyone can access them.Th
https://github.com/secret-super-star/recipe-app
postgresql ruby ruby-on-rails
Last synced: 3 months ago
JSON representation
The Recipe app keeps track of all your foods, recipes, and ingredients. It allows 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. Since sharing recipes is an important part, it allows you to make them public so anyone can access them.Th
- Host: GitHub
- URL: https://github.com/secret-super-star/recipe-app
- Owner: secret-super-star
- Created: 2025-10-07T11:52:23.000Z (9 months ago)
- Default Branch: dev
- Last Pushed: 2025-10-07T12:22:46.000Z (9 months ago)
- Last Synced: 2025-11-11T18:25:00.370Z (8 months ago)
- Topics: postgresql, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 7.28 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
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)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [📝 License](#license)
Recipe App
> The Recipe app keeps track of all your foods, recipes, and ingredients. It allows 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 allows you to make them public so anyone can access them.
- Ruby
- Rails
- Postgresql
Server
- **[A login page]**
- **[A registration page]**
- **[A general shopping list view]**
- [Live Demo Link](https://recipe-app121-b8888e20687b.herokuapp.com/)
To run this project, take a copy of the code and follow the instruction below.
### Prerequisites
You need Ruby v3+, Rails v7+ and Postgresql installed on your machine.
### Setup
`Clone the project`
Install gems with:
```
bundle install
```
Setup database with:
```
rails db:create
rails db:migrate
```
### Usage
Start server with:
```
rails server
```
Visit http://localhost:3000/ in your browser.
### Run tests
Install npm with:
Install rspec with:
```
bundle install
```
and
```
rails generate rspec:install
```
run the test with:
```
rspec spec
```
### Open API documentation
```
rails server
```
Visit http://localhost:3000/api-docs in your browser.
### Usage
- Run `rails server` to run the app.
👤 **Kaung Myat Kyaw**
- Portfolio: [Portfolio](https://rhbarry.me)
- GitHub: [GitHub](https://github.com/Rhaegar121)
- Twitter: [Twitter](https://twitter.com/Rhaegar121)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kaungmyatkyaw/)
👤 **Anthony Martin**
- GitHub: [GitHub](https://github.com/anthonymr)
- Twitter:[Twitter](https://twitter.com/Anthony2Martin)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/anthony-martin-8820a3117/)
## 🔭 Future Features
- [ ] **[Inventories list]**
- [ ] **[Inventory details]**
- [ ] **[Inventory shopping list]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!
This project is [MIT](./MIT.md) licensed.