Recipe-app

📗 Table of Contents

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

📖 Recipe-app

Recipe-app is an app that keeps track of all your recipes, ingredients, and inventory. It allows to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you are missing from a recipe. Built using Ruby on Rails.

🛠 Built With

Tech Stack

Key Features

• User can add foods and recipes to the list
• User can add ingredients to the recipes
• User can generate a shopping list

(back to top)

💻 Getting Started

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

Prerequisites

  Ruby
  Ruby on Rails
  PostgreSQL

Setup

Clone this repository to your desired folder:

  $ git clone git@github.com:lenkon/Recipe-app.git

  $ cd Recipe-app

Install

Install this project with:

  $ cd Recipe-app
  $ bundle install

Usage

To run the project, execute the following command:

  $ rails server

Run tests

  $ rspec

(back to top)

👥 Authors

👤 Inoulen

• GitHub: @K Inoulen Shanongba

👤 Musangamfura Emmanuel

• GitHub
• Twitter
• LinkedIn

(back to top)

🔭 Future Features

• [ ] [Add more projects]
• [ ] [Add milestones and achievements]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project please rate and give a star.

(back to top)

🙏 Acknowledgments

• I would like to thank Microverse team for their support and guidance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)