Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duanedave/recipe-app
https://github.com/duanedave/recipe-app
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/duanedave/recipe-app
- Owner: DuaneDave
- Created: 2022-12-12T13:38:45.000Z (about 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-14T08:46:55.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T14:19:44.481Z (2 months ago)
- Language: Ruby
- Size: 730 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
COOKREADY WEB APPLICATION
# 📗 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)
**CookReady** is an online recipe web app capstone project that makes it easy to find and organize your favorite recipes. With CookReady, you can save and organize your favorite recipes and even generate a shopping list to make sure you have all the ingredients you need. CookReady also allows you to create your own recipes and share them with friends and family. With CookReady, you can make sure that you always have the perfect dish for any occasion. It was build on this [Entity Relationship Diagram](https://github.com/microverseinc/curriculum-rails/blob/main/recipe-app/images/recipe_erd_2_members.png)
> [Ruby on Rails](https://guides.rubyonrails.org/) (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.
Client
Server
Database
> Key features of the application are
- **Create a recipe**
- **Delete recipe**
- **Add food**
- **Generate shopping list**
> Add a link to your deployed project.
- [Live Demo coming soon...](https://yourdeployedapplicationlink.com)
> This project can be used by anyone for any good purpose.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Ruby and Rails on you operating system eg. for [Ubuntu 20.04](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-20-04)
- [Node.js](https://nodejs.dev/en/) installed
- [PostgreSQL](https://www.postgresql.org/) database installed
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/DuaneDave/Recipe-app.git
```
### Install
Install this project with:
```sh
cd Recipe-app
bundle install
```
### Usage
To run the project, execute the following command:
```sh
rails server
```
### Run tests
To run tests, run the following command:
```sh
bin/rails rspec spec
```
### Deployment
You can deploy this project using:
👤 **Ernest Anyewe Adonu**
- GitHub: [@principlebrothers](https://github.com/principlebrothers)
- Twitter: [@adonu_ernest](https://twitter.com/adonu_ernest)
- LinkedIn: [Ernest Anyewe Adonu](www.linkedin.com/in/ernest-anyewe-adonu)
👤 **Obiebi David**
- GitHub: [@githubhandle](https://github.com/DuaneDave)
- Twitter: [@twitterhandle](https://twitter.com/dave_duane)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-obiebi)
- Search functionality
- Add ingredient button functionality
- Page pagination
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/DuaneDave/Recipe-app/issues/new).
If you like this project buy the team a [drink](.../.../)
> Give credit to everyone who inspired your codebase.
We would like to thank [Microverse](https://github.com/principlebrothers/CosmosExpress/issues/new) for inspiring this project
- **Is Rails still relevant?**
- [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)
- **Is it easy to learn Ruby on Rails**
- [It is very easy to learn compared to most of the programming languages](https://careerkarma.com/blog/why-learn-ruby-on-rails/)
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._