shortlink

module
v0.0.0-...-36d8597 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 3, 2023 License: MIT

README ¶

Shortlink is an open-source project that provides a pretty user interface and respects GDPR.
We use edge technologies and have many years of experience.

We're constantly researching the best solutions on the market so that we can benefit
our community and solve a problem for millions of people.

PkgGoDev codecov Go Report Card Releases LICENSE CII Best Practices StackShare FOSSA Status

High Level Architecture 🚀

shortlink-architecture

Architecture (miro.com)
Architecture decision records (ADR)

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

Techradar

shortlink-techradar

Services
Service Description Language/Framework Docs
api Internal GateWay Go docs
billing Billing service Go docs
bot Telegram bot JAVA docs
chat Chat service Elixir (Phoenix) docs
chrome-extension Chrome extension JavaScript docs
shortdb Custom database Go docs
shortdb-operator Kubernetes Operator for shortdb database Go docs
csi CSI example Go docs
link Link service Go docs
logger Logger service Go docs
merch Merch store Coming soon docs
metadata Parser site by API Go docs
newsletter Newsletter service Rust docs
notify Send notify to smtp, slack, telegram Go docs
proxy Proxy service for redirect to original URL TypeScript docs
referral Referral program Python docs
search Search service Coming soon docs
shortctl Shortlink CLI Go docs
stats Stats server CPP docs
support Support service PHP docs
wallet Wallet service Go (Solidity) docs
ws Webscoket service Go docs
Third-party Service
Service Description Language/Framework Docs
ory/kratos User management service Go docs
ory/hydra OAuth 2.0 Provider Go docs
Run
DETAILS

Require
Install GIT sub-repository
git submodule update --init --recursive
docker compose
For run
make run
For down
make down
Kubernetes (1.21+)
For run
make minikube-up
make helm-shortlink-up
For down
make minikube-down
For run
make skaffold-init
make skaffold-up
For down
make skaffold-down
Debug mode
make skaffold-debug

Configuration
DETAILS

View ENV Variables

OpenTracing
DETAILS

http_add_link

UI
Service Description Language/Framework Docs
landing Welcome page JS/NextJS docs
next UI service JS/NextJS docs
ui-kit UI kit for ShortLink JS/React docs
MQ
Kafka RabbitMQ NATS
Cloud-Native stack
  • Development
  • Security
    • SOPS
  • HealthCheck
  • Support K8S
  • MetalLB
  • kyverno - Kubernetes Native Policy Management
  • Storage
    • rook-ceph
      • ceph cluster (3 node)
      • grafana dashboard
      • prometheus metrics
  • Ingress (Gateway)
    • Istio
      • kiali - The Console for Istio Service Mesh
    • Nginx
    • Traefik
Observability
  • Prometheus - Monitoring system
    • prometheus-operator
      • notify: slack, email, telegram

  • Grafana stack (LGTM)

    • Grafana, the open and composable observability and data visualization platform.
    • Loki, like Prometheus, but for logs.
    • Tempo, a high volume, high throughput distributed tracing system.
    • Grafana, the open and composable observability and data visualization platform.
    • OnCall - On-call scheduling
    • Phlare - Profiling and flame graphs
Mobile
  • Hello World on flutter ;-)
CI/CD
GitLab CI GitHub CI ArgoCD
License

FOSSA Status

Directories ¶

Path Synopsis
docs
api
Package api GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
 Package api GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
internal
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/monitoring
di/pkg/mq
di/pkg/profiling
di/pkg/sentry
di/pkg/store
di/pkg/traicing
pkg/batch
Package for work in batch mode
 Package for work in batch mode
pkg/cache
pkg/db
Data Base package
 Data Base package
pkg/db/aerospike
pkg/db/badger
pkg/db/clickhouse
pkg/db/dgraph
pkg/db/edgedb
pkg/db/etcd
pkg/db/leveldb
pkg/db/mongo
pkg/db/neo4j
pkg/db/options
pkg/db/postgres
pkg/db/ram
pkg/db/redis
pkg/db/sqlite
pkg/eventsourcing/store
Billing Service.
 Billing Service.
pkg/eventsourcing/store/postgres
pkg/eventsourcing/v1
pkg/freeport
Get free port
 Get free port
pkg/handle_signal
pkg/i18n
pkg/logger
Logger
 Logger
pkg/logger/field
pkg/logger/tracer
pkg/mq/v1
Message Queue
 Message Queue
pkg/mq/v1/kafka
pkg/mq/v1/nats
pkg/mq/v1/query
pkg/mq/v1/rabbit
pkg/mq/v1/redis
pkg/notify
Notify system
 Notify system
pkg/traicing
Tracing wrapping
 Tracing wrapping
pkg/types/options
pkg/types/queue
pkg/types/thunk
pkg/types/vector
services/api/application
services/api/application/cloudevents
services/api/application/graphql
services/api/application/graphql/resolver
services/api/application/grpc_web/helpers
services/api/application/grpc_web/v1
Package v1 is a reverse proxy.
 Package v1 is a reverse proxy.
services/api/application/http-chi
services/api/application/http-chi/controllers/cqrs
services/api/application/http-chi/controllers/link
services/api/application/http-chi/controllers/sitemap
services/api/di
services/billing/application/account
services/billing/application/order
services/billing/application/payment
services/billing/application/tariff
services/billing/cmd
Shortlink application
 Shortlink application
services/billing/di
services/billing/domain/billing/account/v1
services/billing/domain/billing/order/v1
services/billing/domain/billing/payment/v1
services/billing/domain/billing/tariff/v1
services/billing/infrastructure/api/http
services/billing/infrastructure/api/http/http-chi
services/billing/infrastructure/api/http/http-chi/controllers/account
services/billing/infrastructure/api/http/http-chi/controllers/balance
services/billing/infrastructure/api/http/http-chi/controllers/order
services/billing/infrastructure/api/http/http-chi/controllers/payment
services/billing/infrastructure/api/http/http-chi/controllers/tariff
services/billing/infrastructure/api/rpc/order/v1
services/billing/infrastructure/api/rpc/payment/v1
services/billing/infrastructure/api/rpc/tariff/v1
services/billing/infrastructure/store
Billing Service.
 Billing Service.
services/billing/infrastructure/store/postgres
services/csi
services/csi/cmd
services/csi/di
services/knative/sync-search/kafka-to-elasticsearch
services/link/application/link
Link Service.
 Link Service.
services/link/application/link_cqrs
services/link/application/sitemap
services/link/cmd
Shortlink application
 Shortlink application
services/link/di
services/link/domain/link/v1
Link entity
 Link entity
services/link/domain/link_cqrs/v1
services/link/domain/sitemap/v1
services/link/infrastructure/mq
services/link/infrastructure/rpc/cqrs/link/v1
services/link/infrastructure/rpc/link/v1
services/link/infrastructure/rpc/run
services/link/infrastructure/rpc/sitemap/v1
services/link/infrastructure/store/cqrs/cqs
Store Endpoint
 Store Endpoint
services/link/infrastructure/store/cqrs/cqs/postgres
services/link/infrastructure/store/cqrs/query
Store Endpoint
 Store Endpoint
services/link/infrastructure/store/cqrs/query/postgres
services/link/infrastructure/store/crud
Store Endpoint
 Store Endpoint
services/link/infrastructure/store/crud/badger
services/link/infrastructure/store/crud/dgraph
services/link/infrastructure/store/crud/leveldb
services/link/infrastructure/store/crud/mock
services/link/infrastructure/store/crud/mongo
services/link/infrastructure/store/crud/postgres
services/link/infrastructure/store/crud/query
services/link/infrastructure/store/crud/ram
services/link/infrastructure/store/crud/redis
services/link/infrastructure/store/crud/sqlite
services/logger/application
services/logger/cmd
Shortlink application
 Shortlink application
services/logger/di
services/logger/infrastructure/mq
services/metadata/application
Metadata Service.
 Metadata Service.
services/metadata/cmd
Metadata application
 Metadata application
services/metadata/di
services/metadata/domain/metadata/v1
services/metadata/infrastructure/mq
services/metadata/infrastructure/rpc/metadata/v1
Metadata Service.
 Metadata Service.
services/metadata/infrastructure/store
Metadata Service.
 Metadata Service.
services/metadata/infrastructure/store/mock
services/metadata/infrastructure/store/ram
services/shortctl
CLI tooling
 CLI tooling
services/shortctl/internal/tool
services/ws
services/ws/cmd
services/notify Module
pkg
c4
http/handler
http/middleware
http/server
raft
rpc
rpc/logger
saga
saga/dag
shortdb/cli
shortdb/domain/database/v1
shortdb/domain/field/v1
shortdb/domain/index/v1
shortdb/domain/page/v1
shortdb/domain/query/v1
shortdb/domain/session/v1
shortdb/domain/table/v1
shortdb/engine
shortdb/engine/file
shortdb/engine/file/cursor
shortdb/engine/file/index
shortdb/engine/file/index/binary-tree
shortdb/engine/options
shortdb/io_uring
Package io_uring implements a high-level Go wrapper to perform file read/write operations using liburing.
 Package io_uring implements a high-level Go wrapper to perform file read/write operations using liburing.
shortdb/parser/v1
shortdb/repl
shortdb-operator Module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.