Elijahdre / Recipe-App

COOKREADY WEB APPLICATION

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 [CookReady]

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

🛠 Built With

Tech Stack

Ruby on Rails (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

• Ruby

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Key features of the application are

• Create a recipe
• Delete recipe
• Add food
• Generate shopping list

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo coming soon...

(back to top)

💻 Getting Started

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
• Node.js installed
• PostgreSQL database installed

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/belmeetmule/Recipe-App

Install

Install this project with:

  cd Recipe-app

  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  bin/rails rspec spec

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 Ernest Odjegba

• GitHub: @Elijahdre
• Twitter: @kingglijah
• LinkedIn: Elijah Odjegba

👤 Mulugeta M

• GitHub: @belmeetmule
• Twitter: @belmeetmule
• LinkedIn: belmeetmule

(back to top)

🔭 Future Features

• Search functionality
• Add ingredient button functionality
• Page pagination

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project buy the team a drink

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

We would like to thank Microverse for inspiring this project

(back to top)

❓ FAQ

• Is Rails still relevant?

  • Yes, Rails is still popular among developer

• Is it easy to learn Ruby on Rails

  • It is very easy to learn compared to most of the programming languages

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)