Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kendoriddy/lush-recipe
This is a Ruby on Rails app that allows user to create, delete, and read recipes created by them or the community, allowing the users to decide whether they'd be public or not. Additionally, it allows users to create food records and generate a shopping list based on the missing food for their recipes. It comes with authentication and authorization
https://github.com/kendoriddy/lush-recipe
bootstrap postgresql rails ruby
Last synced: 20 days ago
JSON representation
This is a Ruby on Rails app that allows user to create, delete, and read recipes created by them or the community, allowing the users to decide whether they'd be public or not. Additionally, it allows users to create food records and generate a shopping list based on the missing food for their recipes. It comes with authentication and authorization
- Host: GitHub
- URL: https://github.com/kendoriddy/lush-recipe
- Owner: kendoriddy
- Created: 2022-12-12T11:51:27.000Z (about 2 years ago)
- Default Branch: development
- Last Pushed: 2023-02-20T19:39:15.000Z (almost 2 years ago)
- Last Synced: 2024-11-01T12:11:55.667Z (2 months ago)
- Topics: bootstrap, postgresql, rails, ruby
- Language: Ruby
- Homepage:
- Size: 658 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Microverse README Template
# 📗 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](#faq)
- [📝 License](#license)
> Describe your project in 1 or 2 sentences.
**[your_project__name]** is a...
> Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
> Describe between 1-3 key features of the application.
- **[The app allows users to add recipes and foods]**
- **[It also allows users to declare recipes as public or private]**
- **[It allows users to plan shopping list]**
> Add a link to your deployed project.
- [Live Demo Link](https://yourdeployedapplicationlink.com)
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Setup
Clone this repository to your desired folder:
### Install
Install this project with:
- Run:
```
Bundle Install
rails db:drop
rails db:create
rails db:migrate
To include bootstrap in the project and avoid bootstrap-related errors, run the following commands...
./bin/rails css:install:bootstrap
./bin/rails javascript:install:esbuild
yarn add @hotwired/turbo-rails
yarn add @hotwired/stimulus
THen, start the app with...
rails s
```
### Run tests
To run tests, run the following command:
```
Rspec
```
> Mention all of the collaborators of this project.
👤 **Kehinde Ridwan**
- GitHub: [@kendoriddy](https://github.com/kendoriddy)
- Twitter: [@RideOnOne09](https://twitter.com/RideOnOne09)
- LinkedIn: [Kehinde Onifade](https://www.linkedin.com/in/kehindeonifade/)
👤 **Anas Chaabane**
- GitHub: [@githubhandle](https://github.com/ChaabaneAnas)
- Twitter: [@twitterhandle](https://twitter.com/ChaabaneAnas)
- LinkedIn: [LinkedIn](https://linkedin.com/in/ChaabaneAnas)
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...
> Give credit to everyone who inspired your codebase.
I would like to thank...
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Question_1]**
- [Answer_1]
- **[Question_2]**
- [Answer_2]
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._