tiagomarin/Best-Recepies

The Best Recipies app keeps track of all your recipes, ingredients, and inventory. It allows you to save ingredients, keep track of what you have, create recipes and share them..

📗 Table of Contents

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

📖 Best Recipes

Best Recipes is a place where you can keep record of all your recipes and also check out other recipes from other users. It allows you to save ingredients, keep track of what you have, create recipes and share them. Also you have a shopping list that shows and even to find out what ingredients you need to buy, how many of them and what is the total you will spend.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Database

• PostgreSQL

Styles

• Tailwind CSS

Key Features

• create a list of recipes
• create a list of ingredients (with ingredients from your list
• delete and edit your ingredientes and recipes
• a shopping list where you know exactly what you need to buy

(back to top)

🚀 Live Demo

not available yet

(back to top)

💻 Getting Started

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

Prerequisites

• Ruby installed in your computer. (install guide)
• Rails installed in your computer. (install guide for Ubuntu and Windows)
• Any code editor like Vscode or Vim.

Setup

Clone this repo with git. Run the following command in your terminal:

git clone https://github.com/tiagomarin/Best-Recepies.git

Install

Go to the repo directory and the following command in your terminal:

bundle install

Usage

to see it running on your navigator run the following command in your terminal:

./bin/dev

Run tests

To run tests, run the following command:

  rspec

(back to top)

Author

👤 Tiago Lelinski

• GitHub: @tiagomarin
• Twitter: @LelinskiMarin
• LinkedIn: Tiago

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Thanks to my learning partners for their support and advices

(back to top)

📝 License

This project is MIT licensed.

(back to top)