Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohamedhnoor/recipe-app
This is a simple recipe app that allows users to save ingredients, keep track of their recipes and add new recipes. It also allows users to generate a shopping list based on the ingredients they have saved. This project was built using Ruby on Rails.
https://github.com/mohamedhnoor/recipe-app
bootstrap devise heroku postgresql rspec-rails ruby ruby-on-rails
Last synced: about 4 hours ago
JSON representation
This is a simple recipe app that allows users to save ingredients, keep track of their recipes and add new recipes. It also allows users to generate a shopping list based on the ingredients they have saved. This project was built using Ruby on Rails.
- Host: GitHub
- URL: https://github.com/mohamedhnoor/recipe-app
- Owner: MohamedHNoor
- License: mit
- Created: 2023-04-17T07:46:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-18T22:08:58.000Z (about 1 year ago)
- Last Synced: 2023-10-18T23:23:45.219Z (about 1 year ago)
- Topics: bootstrap, devise, heroku, postgresql, rspec-rails, ruby, ruby-on-rails
- Language: Ruby
- Homepage: https://mhnoor-recipe-app-601ed4646aba.herokuapp.com
- Size: 139 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe App
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [Recipe App ](#recipe-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [Acknowledgments](#acknowledgments)
- [📝 License ](#-license-)
> This is a simple recipe app that allows users to save ingredients, keep track of their recipes and add new recipes. It also allows users to generate a shopping list based on the ingredients they have saved. This project was built using Ruby on Rails.
Server
- [x] Users can create an account and log in.
- [x] Login users can create a new recipe.
- [x] Login users can add ingredients to a recipe.
- [x] Login users can delete a recipe.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- `Ruby --version 3.2.1`
- `Ruby on Rails --version ~> 7.0.4`
- `Postgresql`
### Setup
Clone this repository to your desired folder:
```sh
cd your_desired_folder
git clone https://github.com/MohamedHNoor/recipe-app.git
```
### Install
Install this project with:
- After cloning type `cd recipe-app`.
- Run `bundle install` to install all gems.
### Usage
To run the project, execute the following command:
- Run `rails db:create` to create a new database
- Run `rails db:migrate` to migrate the db and build the schema
- Run `rails s` to start the server
### Run tests
- Run `rspec` to run the tests
👤 **Mohamed Hassan Noor**
- GitHub: [@MohamedHNoor](https://github.com/MohamedHNoor)
- Twitter: [@MohamedHNoor](https://twitter.com/MohamedHNoor)
- LinkedIn: [@MohamedHNoor](https://www.linkedin.com/in/mohamedhnoor/)
👤 **Chimezie Asouzu**
- GitHub: [@Shegy28](https://github.com/shegy28)
- Twitter: [@Shegy28](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/chimezie-asouzu-67704224a/)
- [ ] **Create Inventory list**
- [ ] **Add Inventory details**
- [ ] **Inventory shopping list**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/MohamedHNoor/recipe-app/issues)
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
This project is [MIT](./LICENSE) licensed.