README.md

recipe_app

📗 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, and ingredients. 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

Ruby on Rails

• https://rubyonrails.org/

Key Features

• [Recipe list]
• [Food list]
• [Shopping list]

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

• Install Ruby
• Install Rails
• Install Rspec
• Install Postgresql

Setup

Clone this repository to your desired folder:

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

Install

Install this project with:

  cd recipe_app
  bundle install && npm install

Usage

To run the project, execute the following command:

  rails s

or

./bin/dev

Run tests

To run tests, run the following command:

  rubocop --color

  npx stylelint "**/*.{css,scss}"

  rspec spec

Deployment

• [N/A]

(back to top)

👥 Authors

👤 STEPHEN KATULI

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Sasan Moshirabadi

• GitHub: @dev89s
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• [Recommended recipes]

(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 show support by staring ⭐️.

(back to top)

🙏 Acknowledgments

• We would like to thank my Microverse team and my coding partners for their support and guidance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)