Skip to content

Latest commit

 

History

History
53 lines (27 loc) · 815 Bytes

CODE_MAP.md

File metadata and controls

53 lines (27 loc) · 815 Bytes

Code Map

Code Map explains how the codes are structured in this project. This document will list down all folders or packages and their purpose.

.github

This folder contains the github workflows.

blueprint

This folder contains HTML and dockerfile for API blueprint.

docs

This folder contains all documents related to the project.

gateway

This folder contains code for grpc-gateway server.

infrastructure

This folder contains config related to infrastructure, such as grafana, prometheus, opentelemetry, etc.

openapiv2

This folder contains swagger file for HTTP/1.1 REST.

pkg

This folder contains exported general functionality.

proto

This folder contains all files generated from or based on .proto.