📗 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
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Recipe-App

Recipe-App is an app that 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. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them.

🛠 Built With

Tech Stack

Key Features

• Login authentication
• Postgres database

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

• To install ruby on your PC. You can read this documentation on how to do so
• To install sqlite3 on your PC. You can read this documentation on how to do so
• Know how to navigate directories or folders at the CLI.
• Know how to get the URL(https/ssh) of a repository on GitHub.
• You should have a code editor installed, preferably VSCode.
• In order to run this project you need:

Setup

Clone this repository to your desired folder:

  git clone https://github.com/over-geek/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 spec

(back to top)

👥 Authors

👤 Agyare Kissi Kenneth

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

👤 Franck Kalunga

• GitHub: francksefu
• Twitter: francksefu
• LinkedIn: francksefu

(back to top)

🔭 Future Features

• [ ] Recipes list page
• [ ] Public recipe list page
• [ ] Recipe details page
• [ ] General shopping list view

(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 give me ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this project inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)