goledger/cc-webclient

GoInitus Docker 镜像文档

镜像概述和主要用途

GoInitus 是一个基于 TypeScript 的表单生成器框架，用于动态创建和管理表单输入组件。该 Docker 镜像封装了 GoInitus 项目，提供了一个便捷的方式来部署和运行基于此框架构建的表单应用。

核心功能和特性

• 支持多种输入类型（文本输入、数字输入、日期时间输入）
• 类型安全的组件定义和初始化
• 响应式表单状态管理
• 基于观察者模式的状态更新机制
• 动态表单生成和渲染

使用场景和适用范围

• 快速开发需要复杂表单的 Web 应用
• 构建动态表单系统，支持多种输入类型
• 需要类型安全和状态管理的企业级应用
• 教育和学习环境，展示 TypeScript 表单组件开发最佳实践

详细的使用方法和配置说明

前提条件

• Docker Engine 19.03+
• Docker Compose (可选)

获取镜像

bash
# 从仓库拉取
docker pull goinitus/form-generator:latest

# 或本地构建
git clone https://github.com/example/goinitus.git
cd goinitus
docker build -t goinitus/form-generator:latest .

基本使用方法

使用 docker run 运行

bash
docker run -d -p 8080:80 --name goinitus-app goinitus/form-generator:latest

使用 docker-compose 运行

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  goinitus:
    image: goinitus/form-generator:latest
    container_name: goinitus-app
    ports:
      - "8080:80"
    environment:
      - NODE_ENV=production
      - APP_PORT=80
    volumes:
      - ./mock-data:/app/src/mock
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

配置参数

环境变量

卷挂载

项目结构说明

容器内应用结构：

/app
├── src/
│   ├── types/           # 输入类型定义
│   │   ├── TextInput.tsx
│   │   ├── NumberInput.tsx
│   │   └── DateInput.tsx
│   ├── mock/            # 模拟数据
│   │   └── mockInputs.ts
│   ├── components/      # 表单组件
│   │   ├── CTextInput.tsx
│   │   ├── CNumberInput.tsx
│   │   └── CDateInput.tsx
│   ├── FormGenerator.tsx # 表单生成器
│   └── App.tsx          # 应用入口
├── package.json
└── tsconfig.json

自定义输入类型

要添加自定义输入类型，需挂载包含新类型定义的目录到 /app/src/types，并提供相应的组件实现。

示例：创建自定义下拉选择框类型

1. 创建 SelectInput.tsx 类型定义文件
2. 创建 CSelectInput.tsx 组件文件
3. 挂载到容器中：

bash
docker run -d -p 8080:80 \
  -v ./custom-types:/app/src/types \
  -v ./custom-components:/app/src/components \
  --name goinitus-custom goinitus/form-generator:latest

故障排除

常见问题

1. 端口冲突：确保宿主机端口未被占用，或修改端口映射
2. 自定义类型不生效：检查挂载路径是否正确，文件格式是否符合要求
3. 模拟数据加载失败：验证 JSON 格式是否正确，类型字段是否匹配

查看日志

bash
# Docker 运行方式
docker logs goinitus-app

# Docker Compose 运行方式
docker-compose logs -f

开发模式

如需进行开发和调试，可使用开发模式运行：

bash
docker run -d -p 3000:3000 \
  -e NODE_ENV=development \
  -v $(pwd):/app \
  --name goinitus-dev goinitus/form-generator:latest npm run dev

这将启动开发服务器并启用热重载功能。

镜像维护

更新镜像

bash
# 拉取最新镜像
docker pull goinitus/form-generator:latest

# 重启容器
docker restart goinitus-app

停止和删除容器

bash
# 停止容器
docker stop goinitus-app

# 删除容器
docker rm goinitus-app