Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 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. 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

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• Ruby on Rails

Database

• PostgreSQL

🚀 Live Demo

Add a link to your deployed project.

• Coming Soon

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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

Prerequisites

In order to run this project you need:

• Install Ruby on your local machine
• Install Ruby on Rails

Setup

Clone this repository to your desired folder:

• Clone this repository

Install

Install this project with:

gem install bundler

Then run:

bundle install

Usage

To run the project, execute the following command:

rails s

Open browser with localhost:3000

Run tests

To run tests, run the following command:

rspec .

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Kwaleyela Musilizo Ikafa

• GitHub: @Kwaleyela-Ikafa
• Twitter: @K_Ikafa
• LinkedIn: LinkedIn

👤 Nii Darku

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

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank Microverse

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)