ohyajk / Recipe-App

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

Recipe App

📗 Table of Contents

• 📗 Table of Contents
• Recipe App
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • Acknowledgments
  • 📝 License

Recipe App

This is a simple recipe app that allows users to save ingredients, keep track of their recipes and add new recipes. It also allows users to generate a shopping list based on the ingredients they have saved. This project was built using Ruby on Rails.

🛠 Built With

Tech Stack

Server

• Ruby On Rails

back to top

Key Features

• Users can create an account and log in.
• Login users can create a new recipe.
• Login users can add ingredients to a recipe.
• Login users can delete a recipe.

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby --version 3.2.1
• Ruby on Rails --version ~> 7.0.4
• Postgresql

Setup

Clone this repository to your desired folder:

  cd your_desired_folder
  git clone https://github.com/ohyajk/Recipe-App.git

Install

Install this project with:

• After cloning type cd recipe-app.
• Run bundle install to install all gems.

Usage

To run the project, execute the following command:

• Run rails db:create to create a new database
• Run rails db:migrate to migrate the db and build the schema
• Run rails s to start the server

Run tests

• Run rspec to run the tests

back to top

👥 Authors

👤 Kennedy Owusu

• GitHub: @kennedyowusu
• Twitter: @_iamkobby
• LinkedIn: @kennedy-owusu

👤 Jitender Kumar

• GitHub: @ohyajk
• Twitter: @ohyajk

back to top

🔭 Future Features

• Create Inventory list
• Add Inventory details
• Inventory shopping list

🤝 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

• Hat tip to anyone whose code was used
• Inspiration
• etc

📝 License

This project is MIT licensed.

back to top