README
¶
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.
High Level Architecture 🚀
The project covers the entire process—from identifying Bounded Contexts to implementing microservices using cutting-edge technologies and best practices.
Please star ⭐ the repo if you want us to continue developing and improving ShortLink! 😀
- Boundaries - read more about boundaries.
Contributing
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.
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
boundaries
|
|
|
auth/auth/cmd
Shortlink application
|
Shortlink application |
|
chat/speech-to-text/cmd
Chat boundary
|
Chat boundary |
|
link/metadata/cmd
Metadata application
|
Metadata application |
|
link/metadata/internal/infrastructure/repository/store
Metadata Service.
|
Metadata Service. |
| Metadata UC. | |
|
link/metadata/internal/usecases/parsers
Metadata UC.
|
Metadata UC. |
|
platform/logger/cmd
Shortlink application
|
Shortlink application |
|
api/api-gateway
Module
|
|
|
api/bff-web
Module
|
|
|
billing/billing
Module
|
|
|
billing/wallet
Module
|
|
|
link/bff
Module
|
|
|
link/bff-link
Module
|
|
|
link/link
Module
|
|
|
marketing/report
Module
|
|
|
notification/notify
Module
|
|
|
payment/wallet
Module
|
|
|
platform/csi
Module
|
|
|
platform/istio-extension
Module
|
|
|
platform/shortctl
Module
|
|
|
shop/feed
Module
|
|
|
shop/oms
Module
|
|
|
shop/pricer
Module
|
|
|
shortdb/shortdb-operator
Module
|
|
|
docs
|
|
|
ADR/decisions/proof/ADR-0027
Module
|
|
|
internal
|
|
|
boundaries/api/api-gateway
Module
|
|
|
boundaries/api/bff-web
Module
|
|
|
boundaries/marketing/report
Module
|
|
|
boundaries/payment/wallet
Module
|
|
|
boundaries/platform/csi
Module
|
|
|
boundaries/platform/shortctl
Module
|
|
|
services/api-gateway
Module
|
|
|
services/bff-web
Module
|
|
|
services/csi
Module
|
|
|
services/notify
Module
|
|
|
services/report
Module
|
|
|
services/shortctl
Module
|
|
|
services/shortdb-operator
Module
|
|
|
pkg
|
|
|
batch
Package for work in batch mode
|
Package for work in batch mode |
|
db
Data Base package
|
Data Base package |
|
di
Main DI-package
|
Main DI-package |
|
di/pkg/config
Config package
|
Config package |
|
freeport
Get free port
|
Get free port |
|
logger
Logger
|
Logger |
|
mq
Message Queue
|
Message Queue |
|
notify
Package notify provides a simple notification system.
|
Package notify provides a simple notification system. |
|
observability/traicing
Tracing wrapping
|
Tracing wrapping |
|
pattern/eventsourcing
Package event_store - implementation of event store
|
Package event_store - implementation of event store |
|
golangci-lint/value-object
Module
|
|
|
shortdb-operator
Module
|
|
|
poc
|
|
|
cel
Example use CEL (Common Expression Language)
|
Example use CEL (Common Expression Language) |
|
go-orm
Module
|