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
• License

Recipe Application

Describe your project in 1 or 2 sentences.

[Recipe Application] This project, created using Ruby on Rails, provides a platform for users to discover and save their favorite recipes. With an intuitive interface and a user-friendly design, users can easily browse through a wide range of recipes, view detailed instructions, and save the ones they like for future reference.

Built With

Built with Ruby on Rails

Tech Stack

Key Features

• Create your Favourite Recipe
• Save your favourite Recipe
• Create a shopping list
• Save the amount of food you have in inventories

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need: Ruby, Rails and a Database such as PostgreSQL

Setup

Clone this repository to your desired folder:

  git clone [email protected]:Mhamad-Raad/ruby-on-rails-capstone.git
  cd ruby-on-rails-capstone

Install

Install this project with:

Run the following commands, to be able to use Bootstap and JavsScript. If overwrites, type y

  rails javascript:install:esbuild
  rails css:install:bootstrap

Then run:

  bundle install
  rails db:create
  rails db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

To run all tests, including unit and integration tests, run the following command:

  rspec

Author

Mohammad Raad

• GitHub: @githubhandle
• LinkedIn: LinkedIn

Camilo Vela

• GitHub: @githubhandle
• LinkedIn: LinkedIn

Shaker AbuDrais

• GitHub: @githubhandle
• LinkedIn: LinkedIn

Future Features

• Add the rest of the necessary features for a functional blog.

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project please give it a !

Acknowledgments

Thank you to microverse for setting us on this journey.

License

This project is MIT licensed.