Dongle

This cycle

• Architecture design
• Development environment
• Auth
• Speech service
• Video subtitle service
• Cloud Infra

Table of contents

• 1. Work Cycle
• 2. Directory Layout
• 3. Architecture
• 4. Tech Stack
  • 4.1 Services
  • 4.2 Operation and Deployment
• 5. Additional Info
  • 5.1 Subproject List
  • 5.2 OSS List

---

1. Work Cycle

Color Block : In progress
Color Block : Skip

%%{init: {'theme':'dark'}}%%


flowchart TD
    subgraph Design
        architecture["Architecture"]
        db_schema["DB Schema"]
        api_proto["API Proto"]
    end

    subgraph Preparation
        dev_environment["Dev Environment"]
        google_api_test["Google API Test"]
        whisper_api_test["Whisper model Test"]
        chat_api_test["Chat API Test"]
    end

    subgraph Implementation
        api_gateway["API gateway"]
        auth_service["Auth service"]
        speech_service["Speech service"]
        chatbot_service["Chatbot service"]
        music_service["Video service"]
    end

    subgraph Enhancement
        containerization["Containerization"]
        cloud_infra["Cloud Infra"]
        secret_manager["Secret Manager"]
        ci_cd["CI/CD"]
    end

    subgraph Plan
        purpose["Purpose"]
        requirements["Requirements"]
    end

    Plan --> Design
    Design --> Preparation
    Preparation --> Implementation:::ing
    Implementation --> Enhancement
    Enhancement -->|cycle| Plan

classDef ing fill:#A3C1AD;
style chat_api_test fill:#83502E 
style chatbot_service fill:#83502E 

Loading

2. Directory Layout

.
├── README.md
├── go.mod
├── api # OpenAPI, DB schema, protocol definition
│   ├── db-schema
│   └── proto
│       ├── gen
│       │   └── go
│       │       ├── authpb
│       │       └── speechpb
│       ├── protos
│       │   └── google
│       │       ├── api
│       │       └── protobuf
│       └── scripts
├── app # Main Applications for this project
│   ├── api_gateway
│   │   └── server
│   │       ├── auth
│   │       └── speech
│   │       
│   ├── auth
│   │   └── server
│   └── speech
│       └── server
│           ├── google
│           └── whisper
├── build # Packaging and Continuous Integration.
│   ├── ci
│   └── package
├── deploy # Deployment configurations and templates
│   └── compose
├── docs # Design documents
│   └── architecture
├── internal # Internal packages
│   └── utils
│       └── env
├── test # test apps and test data.
│   └── speech
└── tools # Supporting tools for this project
    └── devcontainer

3. Architecture

4. Tech Stack

4.1 Services

API Gateway (Go)

• gRPC Gateway

Auth (Go)

• Database
  • PostgreSQL
• Token-based
  • Redis : refresh token
• RBAC (Role-based access control)
  • root / admin / user

Chatbot (Python)

• Matching Intent
  • 1: rule-based csv definition
  • 2: deeplearning chat-api

Video (Go)

• Managing Unstructed data
  • object storage: S3

Speech (Go)

• TTS/STT
  • Google
  • Whisper
    
    

4.2 Operation and Deployment

CI/CD

• Github Action, ArgoCD
• Buildah or Kaniko

Deployment

• Compose
• AWS, Terrafrom
  
  
  

5. Additional Info

5.1 Subproject List

Repository	Desc
https://github.com/kimsehyoung/logger	Go Logging package using logrus
https://github.com/kimsehyoung/whisper	STT API server using whisper package

5.2 OSS List

OSS	License	Desc	Link
protobuf	BSD-3-Clause	Google's data interchange format	https://github.com/protocolbuffers/protobuf-go
grpc	Apache-2.0	HTTP/2 based RPC	https://github.com/grpc/grpc-go
grpc-gateway	BSD-3-Clause	RESTful API into gRPC	https://github.com/grpc-ecosystem/grpc-gateway
go-grpc-middleware	Apache-2.0	Go gRPC interceptor auth, logging...	https://github.com/grpc-ecosystem/go-grpc-middleware/v2
validator	MIT	Go Struct and Field validation	https://github.com/go-playground/validator
postgres	similar to BSD or MIT	RDBMS	https://github.com/postgres/postgres
ent	Apache-2.0	An entity framework for Go	https://github.com/ent/ent
pgx	MIT	PostgreSQL driver for Go	https://github.com/jackc/pgx
go-redis	BSD-2-Clause	Redis Go client	https://github.com/redis/go-redis
jwt	MIT	go implementation of JSON Web Tokens	https://github.com/golang-jwt/jwt