Recipe_App

📗 Table of Contents

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

📖 Recipe_app

Recipe_App is a comprehensive app designed to streamline your culinary experience. It serves as your digital kitchen companion, efficiently managing your recipes, ingredients, and pantry inventory. With this app, you can easily save ingredients, monitor your available stock, craft delectable recipes, and even auto-generate a shopping list based on the ingredients required for your chosen recipes.

🛠 Built With

Tech Stack

Client

• Ruby on rails

Database

• postgres

Bootstrap5

• Bootstrap5

Key Features

• Ruby
• Rails
• PostgreSQL (RDB)
• Bootstrap5

(back to top)

💻 Getting Started

To start and run this project

bundle install

rails s

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

Prerequisites

• IDE to edit and run codes (Strongly recommend Visual Studio Code 🔥).
• Git.
• PostgreSQL installed

Install & Setup

To setup and install this project, follow the below steps:

• Clone this project by the command:

$ git clone https://github.com/K0ppai/Recipe_App.git

• Then switch to the project folder by the bellow query:

$ cd Recipe_App

• Install the required dependencies with bundle install
• Install npm dependencies with npm install
• Run rails db:setup
• Run rails db:migrate
• With Ruby on Rails and PostgreSQL installed in your environment, you can run rails server or rails s to run the website.

Tests

• Run rails db:seed RAILS_ENV=test to seed the testing database
• Run rspec

(back to top)

👥 Authors

👤 Paing Soe Thu

• GitHub: @K0ppai
• LinkedIn: Paing Soe Thu

👤 Manzi Tresor

• GitHub: @manzitresor
• LinkedIn: Manzi Tresor

👤 Prosper Kessie

• GitHub: @kessie2862
• LinkedIn: Prosper Kessie

(back to top)

🔭 Future Features

• Add more interactivity and functionality
• Add more styling to improve the UI

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

(back to top)

🙏 Acknowledgments

• We would like to thank Microverse and coding partners for their amazing contribution to the success of this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)