README
¶
Convērs
Start your conversation threads securely across distributed systems.
Getting Started
Requirement
- Docker engine
- Go 1.23.3
- Protocol Buffer
🛠️ Local development
Run command bellow to clone all project's source code
git clone --recurse-submodules -j8 https://github.com/convrz/convers.git $GOPATH/src/github.com/convrz/convers
With SSH Key
git clone --recurse-submodules -j8 git@github.com:convrz/convers.git $GOPATH/src/github.com/convrz/convers
Your project is located in
cd $GOPATH/src/github.com/convrz/convers
Submodules
📂 Protobuf Third Party
googleapisat https://github.com/googleapis/googleapis.git standard rule for REST APIgrpc-gatewayat https://github.com/grpc-ecosystem/grpc-gateway.git plugin protocol buffer to generate reverse proxyprotovalidateat https://github.com/bufbuild/protovalidate.git library to validate structure.
Made in 🇻🇳 🚀
Directories
¶
| Path | Synopsis |
|---|---|
|
api
module
|
|
|
cmd
|
|
|
gateway
Package main provides the entry point for the gateway service.
|
Package main provides the entry point for the gateway service. |
|
srx
Package main provides the entry point for the service registry.
|
Package main provides the entry point for the service registry. |
|
core
module
|
|
|
cvzapp
Package cvzapp provides the application layer for the service.
|
Package cvzapp provides the application layer for the service. |
|
cvzconfig
Package cvzconfig provides the configuration for the service.
|
Package cvzconfig provides the configuration for the service. |
|
cvzfactory
Package cvzfactory provides the factory for the service.
|
Package cvzfactory provides the factory for the service. |
|
cvzhook
Package cvzhook provides a way to hook into the application lifecycle.
|
Package cvzhook provides a way to hook into the application lifecycle. |
|
cvzruntime
Package cvzruntime provides the runtime for the service.
|
Package cvzruntime provides the runtime for the service. |
|
cvzservice
Package cvzservice provides a service registrar.
|
Package cvzservice provides a service registrar. |
|
internal
Package cvzinternal provides internal utilities for the Convērs service.
|
Package cvzinternal provides internal utilities for the Convērs service. |
|
internal
|
|
|
apps/gateway
Package gateway provides the gateway app.
|
Package gateway provides the gateway app. |
|
apps/gateway/services/base
Package base provides the base service.
|
Package base provides the base service. |
|
apps/gateway/services/greeter
Package greeter provides the greeter service.
|
Package greeter provides the greeter service. |
|
apps/gateway/visitor
Package visitor provides an implementation of the visitor pattern.
|
Package visitor provides an implementation of the visitor pattern. |
|
apps/registry
Package registry provides the registry service.
|
Package registry provides the registry service. |
|
apps/registry/etcd
Package etcd provides an implementation of the registry using etcd.
|
Package etcd provides an implementation of the registry using etcd. |
|
apps/registry/server
Package server provides the server for the service registry.
|
Package server provides the server for the service registry. |
|
namespace
Package namespace provides a namespace.
|
Package namespace provides a namespace. |
|
version
Package version provides the version of the package.
|
Package version provides the version of the package. |
|
pkg
|
|
|
context
Package context provides a context with a message.
|
Package context provides a context with a message. |
|
copier
Package copier provides functions to copy objects.
|
Package copier provides functions to copy objects. |
|
db
Package db provides the database interface.
|
Package db provides the database interface. |
|
db/es
Package es provides an implementation of the database using elasticsearch.
|
Package es provides an implementation of the database using elasticsearch. |
|
db/pg
Package pg provides an implementation of the database using PostgreSQL.
|
Package pg provides an implementation of the database using PostgreSQL. |
|
db/redis
Package redis provides an implementation of the database using redis.
|
Package redis provides an implementation of the database using redis. |
|
logger
Package logger provides the logger for the service.
|
Package logger provides the logger for the service. |
|
models
Package models provides the models for the service.
|
Package models provides the models for the service. |
|
pb
Package pb provides utilities for working with protobuf messages.
|
Package pb provides utilities for working with protobuf messages. |
|
pb/proto
Package proto provides the proto package.
|
Package proto provides the proto package. |
|
pb/types
Package types provides the types for the service.
|
Package types provides the types for the service. |
|
utils
Package utils provides utility functions for the service.
|
Package utils provides utility functions for the service. |
Click to show internal directories.
Click to hide internal directories.