README.md

Recipe app

📗 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 (OPTIONAL)
• 📝 License

📖 Recipe App

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe. Also, since sharing recipes is an important part of cooking the app allows you to make them public so anyone can access them.

🛠 Built With

• Ruby
• Ruby on Rails
• VSCode
• Rubocop
• PostgreSQL

Tech Stack

Linters

• StyleLint
• Rubocop

Server

• Ruby

Database

• PostgreSQL

Key Features

• Add, delete, update, edit foods
• Add, delete, update, edit recipes
• Add, delete, update, edit shopping list

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Setup

Clone this repository to your desired folder:

  cd PATH
  git clone https://github.com/PromzzyKoncepts/Recipe-App

Install

Install this project with:

  cd Recipe-app
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec

(back to top)

👥 Authors

👤 Khusniddin Ismoilov

• GitHub: @KIsmoilov
• LinkedIn: LinkedIn

👤 PROMISE OKECHUKWU

• GitHub: @promzzykoncepts
• Twitter: @pr0mzzy
• LinkedIn: promiseokechukwu

(back to top)

🔭 Future Features

• Save recipes as pdf file

(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 kindly give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the project idea

(back to top)

📝 License

This project is MIT licensed.

(back to top)