/CookPad

This is a recipe app that can keep track of all your recipes, ingredients, and inventory.

Primary LanguageRubyMIT LicenseMIT

📗 Table of Contents

📖 CookPad🍜

The CookPad 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

🛠 Built With

Tech Stack

Here are List of technologies used on this project

Languages
Framework
Database
Linters
Test library

Key Features

  • Create recipes
  • Generate a shopping list based on what you have.
  • Keeps track of all your recipes, ingredients, and inventory.

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

  • Ruby installed on your computer

Setup

Clone this repository to your desired folder:

  git clone https://github.com/killy10o10/cookPad.git

change directory to cloned folder

  cd cookPad

Install

Install project dependecies with:

  bundle install

Usage

To run the project, execute the following command:

  rails server

  • After running rails server, open your browser and enter this address http://localhost:3000/

  • Congratulations! your're running cookPad

(back to top)

👥 Authors

👤 Quami Killy

👤 Tracy Musongole

👤 Kibirige John

(back to top)

🔭 Future Features

These features will be added in future updates. ⬇️⬇️

  • Controllers specs
  • Processing data in models
  • Add api endpoint for generating recipes

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

If you like👍🏽 this project, give the repository a star ⭐

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse community

📝 License

This project is MIT licensed.

(back to top)