Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dennis-every/recipes-app
Foodie is a recipes app built with Ruby on Rails which keeps track of recipes and ingredients. It allows registered users to save ingredients, create recipes, and generate a shopping list.
https://github.com/dennis-every/recipes-app
postgresql ruby-on-rails
Last synced: about 1 month ago
JSON representation
Foodie is a recipes app built with Ruby on Rails which keeps track of recipes and ingredients. It allows registered users to save ingredients, create recipes, and generate a shopping list.
- Host: GitHub
- URL: https://github.com/dennis-every/recipes-app
- Owner: dennis-every
- License: mit
- Created: 2023-05-22T19:08:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-11T20:05:49.000Z (over 1 year ago)
- Last Synced: 2024-11-24T21:04:05.424Z (about 2 months ago)
- Topics: postgresql, ruby-on-rails
- Language: Ruby
- Homepage: https://recipes-app-5gsd.onrender.com
- Size: 181 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipes App
# 📗 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)
- [📝 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.
Client
Server
Database
- **ROR**
- **Devise**
To get a local copy of this project and run it in your computer, follow these steps.
### Prerequisites
In order to run this project you need:
- A working computer.
- Connection to internet.
### Setup
To get a local copy up and running follow these simple example steps.
Clone this repository in the desired folder:
```
cd my-folder
git clone https://github.com/dennis-every/recipes-app.git
```
### Install
To install this project:
```
cd recipes-app
code .
bundle install
```
### Usage
To run the project, execute the following command:
```
rails server
```
### Run Tests
For rails +7, include the following in your gemfile in the development, test group:
```
group :development, :test do
gem 'rspec-rails'
end
```
and
```
gem 'rails-controller-testing'
```
then run:
```
bundle install
```
To setup rspec, run the following:
```
rails generate rspec:install
```
To run the project tests, execute the following command:
```
rspec
```
👤 **Ashmal Zahra**
- GitHub: [@ashmalzahra](https://github.com/ashmalzahra)
- Twitter: [@AshmalZahraa](https://twitter.com/AshmalZahraa)
- LinkedIn: [ashmal-zahra](https://www.linkedin.com/in/ashmal-zahra)
👤 **Dennis Every**
- GitHub: [@dennis-every](https://github.com/dennis-every)
- Twitter: [@dennis_every](https://twitter.com/dennis_every)
- LinkedIn: [dennis-every](https://www.linkedin.com/in/dennis-every/)
- [ ] **Deployment.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/dennis-every/recipes-app/issues).
Give a ⭐️ if you like this project!
This project is [MIT](./LICENSE) licensed.