PUNK API Project 🍺

The PUNK API Project is an interactive web application that allows users to explore and discover a wide variety of beers from the BrewDog brewery. Powered by the Punk API (API CURRENTLY DOWN SO USING A DATA FILE), this project provides users with access to extensive information about different beers, including their names, taglines, descriptions, ABV (Alcohol by Volume), and more.

Features

• Beer Exploration: Browse through a vast collection of beers sourced from the BrewDog brewery.
• Detailed Beer Information: Access comprehensive details about each beer. Click on a beer for a modal to pop up with more info!

Technologies Used

• TypeScript: Programming language used for adding interactivity and logic to the application.
• HTML/SCSS: Used for creating the structure and styling of the web interface.
• Punk API: External API used for retrieving data about BrewDog beers. (CURRENTLY DOWN)
• React Router: For page routing

How to Use

1. Clone or download the repository to your local machine.
2. Open the terminal and navigate to the project directory.
3. Run npm install to install dependencies.
4. Run npm run dev to start the development server.
5. Open the provided localhost link in your web browser.
6. Explore the collection of beers and enjoy discovering new favorites!

Live Demo : [https://athishthayalan.github.io/punkapi/]

Project Structure

src/: Root directory of the project.

• components/: Contains reusable UI components used throughout the application. Contains relevant styling, functionality and testing
• containers/: Houses container components responsible for page routing.
• data/: Stores current beer data that is in use. Due to API being down
• assets/: Holds static assets, such as images, icons, or fonts, used in the project.
• styles/: Stores CSS or SCSS files for styling the application.
• index.html: Main HTML file containing the structure of the web interface.
• app.tsx: TypeScript file containing the logic and functionality of the application.
• README.md: Documentation file providing information about the PUNK API Project.

Enjoy exploring the world of BrewDog beers with the PUNK API Project!