https://github.com/rualca/punk-da-beer

PunkDaBeer is an open‑source beer listing.
https://github.com/rualca/punk-da-beer

angular hexagonal-architecture nodejs solid typescript

Last synced: 2 months ago
JSON representation

PunkDaBeer is an open‑source beer listing.

• Host: GitHub
• URL: https://github.com/rualca/punk-da-beer
• Owner: rualca
• Created: 2025-03-03T11:58:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-03T11:59:35.000Z (over 1 year ago)
• Last Synced: 2025-06-06T05:02:06.954Z (about 1 year ago)
• Topics: angular, hexagonal-architecture, nodejs, solid, typescript
• Language: TypeScript
• Homepage:
• Size: 619 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  

    

  

  

    

  

  

  [![Website shields.io](https://img.shields.io/website-up-down-green-red/http/shields.io.svg)](http://shields.io/)

  [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

  [![made-with-Markdown](https://img.shields.io/badge/Made%20with-Markdown-1f425f.svg)](http://commonmark.org)

  [![made-with-javascript](https://img.shields.io/badge/Made%20with-JavaScript-1f425f.svg)](https://www.javascript.com)

  [![Minimum node.js version](https://badgen.net/npm/node/express)](https://npmjs.com/package/node)

  [![GitLab last commit](https://badgen.net/gitlab/last-commit/rualca/punk-da-beer/)](https://gitlab.com/rualca/punk-da-beer/-/commits)

  [![GitLab branch](https://badgen.net/gitlab/branches/rualca/punk-da-beer/)](https://gitlab.com/rualca/punk-da-beer/-/branches)

  [![Docker](https://badgen.net/badge/icon/docker?icon=docker&label)](https://https://docker.com/)



  

PunkDaBeer is an open‑source beer listing.


# Backend Features

The backend have:

- A public route to login

- A private route to get a beer

- A private route to autocomplete beer name or ingredient

- A private route to get a beer based on main filters(name, ingredients)

- A private route to get the top 10 ingredients more repeated

- Saved each request in DB, to audit client information

And of course, this project counts with:

- Clarity and structure

- Use of SOLID principles

- Use of patterns

- Tests

# Frontend Features

The frontend have:

  - A login page

  - A list of beers private page that lists all beers. And a autocomplete to filter beers by name or ingredient, in the right part you must show a top 10 list of beers.

  

  💡 You must use a single input for this autocomplete. The options displayed will be the ingredients or names that match part of the text entered. When the user chooses a valid ingredient or name from those available, the Top 10 beer list should be updated ordered by `first_brewed` field

  

  - A detailed private page of a beer(image, description, etc...), lets your creativity fly.

  And of course, this project counts with:

- Clarity and structure

- Custom components and style

- Methodology and reusable principles

- Tests

# Getting Started

You can get started with PunkDaBeer immediately executing:

```

docker-compose up

```