shortlink

# shortlink ShortLink is an open-source educational project that provides a pretty user interface and respects GDPR. The goal of the project is to demonstrate the practical application of microservices architecture. [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/shortlink)](https://artifacthub.io/packages/search?repo=shortlink) [![PkgGoDev](https://pkg.go.dev/badge/mod/github.com/shortlink-org/shortlink)](https://pkg.go.dev/mod/github.com/shortlink-org/shortlink) [![codecov](https://codecov.io/gh/shortlink-org/shortlink/branch/main/graph/badge.svg?token=Wxz5bI4QzF)](https://codecov.io/gh/shortlink-org/shortlink) [![Go Report Card](https://goreportcard.com/badge/github.com/shortlink-org/shortlink)](https://goreportcard.com/report/github.com/shortlink-org/shortlink) [![Releases](https://img.shields.io/github/release-pre/shortlink-org/shortlink.svg)](https://github.com/shortlink-org/shortlink/releases) [![LICENSE](https://img.shields.io/github/license/shortlink-org/shortlink.svg)](https://github.com/shortlink-org/shortlink/blob/main/LICENSE) [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3510/badge)](https://bestpractices.coreinfrastructure.org/projects/3510) [![StackShare](http://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](https://stackshare.io/shortlink-org/shortlink) [![FOSSA Status](https://app.fossa.com/api/projects/custom%2B396%2Fgithub.com%2Fshortlink-org%2Fshortlink.svg?type=shield)](https://app.fossa.com/projects/custom%2B396%2Fgithub.com%2Fshortlink-org%2Fshortlink?ref=badge_shield) [![DeepSource](https://app.deepsource.com/gh/shortlink-org/shortlink.svg/?label=active+issues&show_trend=true&token=DL-zlqtnyx6CvlHCroG0Jdx5)](https://app.deepsource.com/gh/shortlink-org/shortlink/)

High Level Architecture 🚀

The project covers the entire process—from identifying Bounded Contexts to implementing microservices using cutting-edge technologies and best practices.

shortlink-architecture Please star ⭐ the repo if you want us to continue developing and improving ShortLink! 😀

Boundaries - read more about boundaries.

Contributing

Getting Started

Architecture decision records (ADR)

[!IMPORTANT] An architecture decision record (ADR) is a document that captures an important architecture decision made along with its context and consequences.

Docs ADR

Decisions:

main decisions

ops decisions

Also, each boundary context and service has its own ADR. You can find them in the relevant sections.

License

[!WARNING]

This project includes dependencies licensed under the GNU Lesser General Public License (LGPL). Users must comply with LGPL terms when using or modifying these dependencies. For detailed information on each LGPL library used in this project, please refer to the respective license documentation included with each library. For comprehensive license compliance information, including dependencies and their licenses, you can read more details in our FOSSA report.