shortlink

module

v0.0.0-...-9dfb24e Latest Latest Go to latest Published: Dec 24, 2024 License: MIT

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/shortlink-org/shortlink

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.

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.

Directories ¶

Path	Synopsis
boundaries
auth/auth/cmd Shortlink application	Shortlink application
auth/auth/internal/di
auth/auth/internal/services/permission
chat/speech-to-text/cmd Chat boundary	Chat boundary
chat/speech-to-text/di
link/metadata/cmd Metadata application	Metadata application
link/metadata/internal/di
link/metadata/internal/domain/metadata/v1
link/metadata/internal/infrastructure/mq
link/metadata/internal/infrastructure/repository/media
link/metadata/internal/infrastructure/repository/store Metadata Service.	Metadata Service.
link/metadata/internal/infrastructure/repository/store/error
link/metadata/internal/infrastructure/repository/store/ram
link/metadata/internal/infrastructure/rpc/metadata/v1 Metadata UC.	Metadata UC.
link/metadata/internal/usecases/metadata
link/metadata/internal/usecases/parsers Metadata UC.	Metadata UC.
link/metadata/internal/usecases/screenshot
platform/logger/cmd Shortlink application	Shortlink application
platform/logger/internal/application
platform/logger/internal/di
platform/logger/internal/infrastructure/mq
shop/merch/usecases/delivery_order_to_customer/pkg
shop/merch/usecases/order-processor/pkg
shortdb/shortdb/cli
shortdb/shortdb/domain/database/v1
shortdb/shortdb/domain/field/v1
shortdb/shortdb/domain/index/v1
shortdb/shortdb/domain/page/v1
shortdb/shortdb/domain/query/v1
shortdb/shortdb/domain/session/v1
shortdb/shortdb/domain/table/v1
shortdb/shortdb/engine
shortdb/shortdb/engine/file
shortdb/shortdb/engine/file/cursor
shortdb/shortdb/engine/file/index
shortdb/shortdb/engine/file/index/binary-tree
shortdb/shortdb/engine/options
shortdb/shortdb/io_uring
shortdb/shortdb/parser/v1
shortdb/shortdb/repl
api/api-gateway Module
api/bff-web Module
billing/billing Module
billing/wallet Module
link/bff Module
link/bff-link Module
link/link Module
link/supplies/knative/kafka-to-elasticsearch 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/knative/kafka-to-elasticsearch Module
boundaries/link/supplies/knative/kafka-to-elasticsearch Module
boundaries/marketing/report Module
boundaries/payment/wallet Module
boundaries/platform/csi Module
boundaries/platform/shortctl Module
boundaries/shortdb/shortdb-operator Module
services/api-gateway Module
services/bff-web Module
services/csi Module
services/knative/kafka-to-elasticsearch Module
services/notify Module
services/report Module
services/shortctl Module
services/shortdb-operator Module
pkg
auth
auth/session
batch Package for work in batch mode	Package for work in batch mode
cache
concurrency/channel
concurrency/rate_limiter
concurrency/sync_map
concurrency/worker_pool
db Data Base package	Data Base package
db/aerospike
db/badger
db/clickhouse
db/cockroachdb
db/couchbase
db/dgraph
db/edgedb
db/etcd
db/leveldb
db/mongo
db/mongo/migrate
db/mysql
db/mysql/migrate
db/neo4j
db/options
db/postgres
db/postgres/migrate
db/ram
db/redis
db/sqlite
di Main DI-package	Main DI-package
di/pkg/autoMaxPro
di/pkg/config Config package	Config package
di/pkg/context
di/pkg/flags
di/pkg/logger
di/pkg/mq
di/pkg/permission
di/pkg/profiling
di/pkg/store
di/pkg/temporal
di/pkg/traicing
freeport Get free port	Get free port
fsm
graceful_shutdown
http/client
http/handler
http/middleware/auth
http/middleware/logger
http/middleware/metrics
http/middleware/pprof_labels
http/middleware/request_size
http/middleware/singleflight
http/middleware/span
http/server
logger Logger	Logger
logger/config
logger/field
logger/logrus
logger/tracer
logger/zap
mq Message Queue	Message Queue
mq/kafka
mq/nats
mq/query
mq/rabbit
mq/redis
notify Package notify provides a simple notification system.	Package notify provides a simple notification system.
observability/common
observability/logging
observability/monitoring
observability/traicing Tracing wrapping	Tracing wrapping
pattern/eventsourcing Package event_store - implementation of event store	Package event_store - implementation of event store
pattern/eventsourcing/domain/eventsourcing/v1
pattern/eventsourcing/store/postgres
pattern/saga
pattern/saga/dag
pattern/specification
pattern/specification/example
pattern/transactional_outbox
pattern/transactional_outbox/domain/transactional_outbox/v1
protoc/protoc-gen-go-orm
protoc/protoc-gen-rich-model
protoc/protoc-gen-rich-model/fixtures
protoc/protoc-gen-rich-model/options/v1
raft
raft/rpc/v1
raft/server
raft/v1
rpc
rpc/middleware/logger
rpc/middleware/pprof
rpc/middleware/session
s3
types/options
types/partmap
types/queue
types/thunk
types/vector
uow
uow/mocks
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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL