/Recipe-App

This 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.

Primary LanguageRubyMIT LicenseMIT


Recipe App

📗 Table of Contents

📖 Recipe

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.

🛠 Built With

Tech Stack

Server
  • Ruby
  • Rails
  • Database
  • Postgres
  • Key Features

    • Keep track of Ingredients
    • Keep track of Recipes
    • Keep track of Inventory
    • Generate a shopping list

    (back to top)

    🚀 Live Demo

    (back to top)

    💻 Getting Started

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

    Prerequisites

    In order to run this project you need:

        ruby >= 3.2.0
        rails >= 7.0
        postgres >- 15.3
    

    Setup

    Clone this repository to your desired folder:

      git git@github.com:marvin-nyalik/Recipe.git

    You need to setup database for these project

      development = recipe_dev
      test        = recipe_test
      production  = Recipe_production
    

    or you can use your own database and change the config/database.yml

      default: &default
        adapter: postgresql
        encoding: unicode
        pool: 5
        username: [your_username]
        password: [your_password]
        host: localhost
    
      development:
        <<: *default
        database: [your_database_for_development]
    
      test:
        <<: *default
        database: [your_database_for_test]
    
      production:
        <<: *default
        database: [your_database_for_production]

    Install

    Install this project with:

      cd Recipe
      bundle install

    it will install the required gemfile for running the project

    Usage

    to use this project:

       rails server -p 3000
      rails tailwindcss:watch
    

    it will run the server on localhost:3000

    (back to top)

    👥 Author

    👤 MD. Nohain Islam

    👤 Marvin Otieno

    👤 Ansar Ibrahim

    (back to top)

    🔭 Future Features

    • Add checkout
    • Implement in-app communication
    • Add recipe preparation video links

    (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 you can share this project to your friend

    (back to top)

    🙏 Acknowledgments

    I would like to thank microverse for defining these project requirements

    (back to top)

    📝 License

    This project is MIT licensed.

    (back to top)