Recipe App

(Project ERD)

📗 Table of Contents

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

📖 Recipe App

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

Client

• HTML/CSS

Server

• Rails

Database

• PostgreSQL

Key Features

• CRUD functionailties
• Database Migrations
• Test coverage
• Database Associations
• Database Validations
• Authentication
• Authorization

(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:

 brew install ruby (on Mac OS)

Setup

Clone this repository to your desired folder:

  git clone https://github.com/peterdtitan/recipe_app.git

Install

Install this project with:

  cd recipe_app
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

Deployment

This project is run locally and has no deployments yet.

(back to top)

👥 Authors

👤 Peter Okorafor

• GitHub: @peterdtitan
• Twitter: @PeterDeTitan
• LinkedIn: Peter OKorafor

👤 Santosh Konappanavar

• GitHub: @Santosh-Konappanavar
• Twitter: @SantoshKonapp1
• LinkedIn: @Santosh Konappanavar

(back to top)

🔭 Future Features

There will be no future features available for this project as it will be deprecated soon. However, the following may be done:

• Code Refactoring
• Modification of modules
• More unit tests.

(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 please give it a star and follow me.

(back to top)

🙏 Acknowledgments

I would like to thank (Microverse)[https://github.com/microverseinc] for providing the learning support as well as all collaborators on this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)