README.md

📗 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

📖 Project

"Beers-Lovers" is a website that displays details of Brewdog beers. It allows users to search for their favorite beers or filter based on categories.

🛠 Built With

• HTML
• CSS
• JS
• React

Tech Stack

Client

• JavaScript
• HTML
• CSS

Key Features

Using the project will help you to :

• Filter beers by name and get their details

(back to top)

🚀 Live Demo

• Beer Lovers Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Node js installed on your computer
• Npm Node package manager
• Terminal

Setup

Clone this repository by using the command line :

• git clone https://github.com/manq2010/beer-lovers.git

Install

Install this project with:

npm install

Usage

To run the project, execute the following command:

npm start

Run tests

To run tests, run the following command:

npm test

Deployment

You can deploy this project using:

npm run deploy

(back to top)

👥 Authors

👤 Mancoba Sihlongonyane

• GitHub: @manq2010
• Twitter: @mancoba_c
• LinkedIn: mancobasihlongonyane

(back to top)

🔭 Future Features

• Add filter options for other catergories ⏳⌛️

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Thank you

• Microverse for the project
• Punk Api for the API and documentation
• Behance for the design

(back to top)

❓ FAQ

• How to use the project

  • git clone https://github.com/manq2010/beer-lovers.git

• How to contribute to the project

  • Fork it by using fork button, or you can contact me.

(back to top)

📝 License

This project is MIT licensed.

(back to top)