Xghayor / Recipe-craft

Your all-in-one solution for recipe management, ingredient tracking, and inventory control. Save, organize, and effortlessly create recipes. Generate shopping lists and share recipes seamlessly. Where culinary creativity meets organized simplicity.

📗 Table of Contents

• 📗 Table of Contents
• 👨‍💻 Recipe Craft
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Database Setup
    • Running the App
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📝 License

👨‍💻 Recipe Craft

The Recipe Craft App allows you to easily manage your recipes and ingredients. You can save ingredients, track your stock, create new recipes, and generate a shopping list based on your needs. The app also encourages recipe sharing, with the option to make them public for everyone to enjoy.

🛠 Built With

Tech Stack

Server

• Ruby
• RubyOnRails

Database

• PostgreSQL

Key Features

The key features of this project include.

• Manage recipes and ingredients
• Save and organize ingredients
• Create and develop new recipes
• Generate shopping lists based on recipe needs
• Option to make recipes public for everyone to access

(back to top)

💻 Getting Started

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

Prerequisites

Before you begin, make sure you have the following installed on your machine:

• Ruby: You can download Ruby here.
• Rails: You can install Rails by running the command gem install rails in your terminal.
• A code editor (like VSCode, Sublime, Atom, etc.): You can download VSCode here, Sublime here, and Atom here.
• Git: You can download Git here.
• Node.js: You can download Node.js here.

Setup

To setup this project locally:

1. Open terminal in VScode.
2. Navigate to the directory where you want clone the copy of this repository.
3. Create new directory [optional].
4. Clone the repository by running the following command:

git clone [e-mail]:Xghayor/Recipe-craft.git

5. Navigate into the cloned repository:

cd Recipe-craft

Installation

Install the required dependencies by running the following command:

bundle install

Database Setup

To create the database, run the following command:

rails db:create

To migrate the database schema, run the following command:

rails db:migrate

Running the App

To run the application, run the following command:

rails server

This will start the Rails development server and you can access the application by visiting http://localhost:3000 in your web browser.

(back to top)

👥 Authors

The collaborators of this project.

👨‍🚀 M Nisar Ali

• GitHub: @MNisarAli
• Gmail: @[e-mail]
• LinkedIn: @Muhammad Nisar Ali

👨‍🚀 Ghayoor Ul Baqir

• GitHub: @Xghayor
• LinkedIn: Ghayoor-Ul-Baqir

(back to top)

🔭 Future Features

• More conditional checking and features will be added in future

(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!, also follow us on GitHub, @Ghayor & LinkedIn.

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverseinc for Readme-template.

(back to top)

📝 License

This project is MIT licensed.

(back to top)