2. Documentation for Vatz Project Design

[xellos00]

• Parents: #97

  Checklist

• [ ] New Feature for the Service/Plugin (Vatz)

• [ ] Enhancement (Vatz)

• [x] others(etc. e.g, documentation, project policy management)

---

Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is. such as Ex. I'm always frustrated

I'm always frustrated we do not have any document that demonstrate our project architecture and its design.

Describe the solution you'd like| Ex

A clear and concise description of what you want to happen I want to create a page on Gitbook that explain for followings

• Use gdrive to create Vatz project Design overall

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you have considered.

Additional context or comment

Add any other context or screenshots about the feature request here.

[xellos00]

AS-IS

[xellos00]

TO-BE

Please, give me any feedback for above. Link @dsrvlabs/validator

[xellos00]

Tasks

@rootwarp @xellos00

1. Interface Type -> module 정리
2. CLI Command
   • (TBD)
   • config
3. rest of tasks
   • 3.2 Health checker
   • 3.3 Monitoring

[xellos00]

├── vatz
│   ├── Makefile
│   ├── README.md
│   ├── default.yaml
│   ├── docs
│   │   ├── contributing.md
│   │   └── workflow.md
│   ├── go.mod
│   ├── go.sum
│   ├── main.go
│   ├── manager
│   │   ├── api
│   │   │   ├── api.go
│   │   │   └── api_test.go
│   │   ├── config
│   │   │   ├── config.go
│   │   │   ├── config_test.go
│   │   │   └── fixtures.go
│   │   ├── executor
│   │   │   ├── executor.go
│   │   │   └── executor_manager.go
│   │   ├── healthcheck
│   │   │   ├── healthcheck.go
│   │   │   └── healthcheck_manager.go
│   │   ├── model
│   │   │   ├── config.go
│   │   │   └── notification.go
│   │   └── notification
│   │       ├── notification.go
│   │       └── notification_manager.go
│   └── sdk
│       ├── Makefile
│       ├── README.md
│       ├── bootstrap
│       │   └── main.template
│       ├── go.mod
│       ├── go.sum
│       ├── grpc.go
│       ├── grpc_test.go
│       ├── log.go
│       ├── sdk.go
│       └── sdk_test.go

[xellos00]

• Post TODOs
  • Refactoring @rootwarp first.
  • Module has no default. Refer to https://github.com/zeromicro/go-zero -> will create a prefer module structure.