ZUS System on Blockchain Technology Based on Golang

A concept for a modern social insurance platform.

The project aims to create a transparent, secure, and automated platform that leverages the advantages of distributed ledger technology and the performance and reliability of Go to serve millions of users.

Context

A detailed project description can be found in docs/SPECIFICATION.md.

Project Structure

Directory Structure

zus-blockchain/
├── api/                        # API definitions (OpenAPI, gRPC .proto)
│   ├── openapi/
│   └── proto/
├── cmd/                        # Main applications (microservice entry points)
│   ├── zus_api_gateway/
│   ├── contribution_service/
│   ├── benefit_service/
│   ├── identity_service/
│   ├── audit_service/
│   └── oracle_service/
├── configs/                    # Application configuration files
├── deployments/                # Deployment scripts and configs (Docker, K8s)
│   ├── docker-compose/
│   └── kubernetes/
├── docs/                       # Project documentation
│   └── SPECIFICATION.md        # Detailed system specification
├── internal/                   # Internal application and library code
│   ├── adapters/               # Adapters for external technologies (DB, Blockchain, HTTP)
│   │   ├── blockchain_connector/
│   │   ├── storage/
│   │   ├── http/
│   │   ├── grpc/
│   │   └── messaging/
│   ├── core/                   # Core business logic (domain, ports, services)
│   │   ├── domain/
│   │   ├── ports/
│   │   └── services/
│   ├── auth/                   # Authentication and authorization module
│   ├── config/                 # Configuration management
│   ├── integrations/           # Integrations with external systems
│   └── platform/               # Platform components (logger, crypto)
├── pkg/                        # (Optional) Libraries shared with other projects
├── scripts/                    # Helper scripts (build, run, test)
├── smartcontracts/             # Smart contract code
│   ├── fabric/                 # For Hyperledger Fabric (e.g., chaincode in Go)
│   └── cosmos_sdk/             # For Cosmos SDK (modules)
├── test/                       # Integration and E2E tests
├── .gitignore                  # Files ignored by Git
├── go.mod                      # Go module definition
├── go.sum                      # Go dependency checksums
├── LICENSE                     # Project license
└── README.md                   # This file

Prerequisites

• Go (version >= 1.20)
• (optional) Docker & Docker Compose (for blockchain development environment)
• (optionally other tools, e.g., Make)

Getting Started

(Instructions will be added in the future)

Testing

(Instructions will be added in the future)

Contribution

(Contribution guidelines will be added in the future)

License

This project is licensed under the MIT License. See the LICENSE file for details.