claytoncountysd/integrationservice

镜像概述

本Docker镜像专为Node.js项目开发设计，提供完整的开发环境配置，集成npm脚本管理、Git子模块维护、环境变量注入及Docker Compose部署支持，旨在简化开发流程，提升开发效率。

核心功能与特性

• 依赖管理：支持通过npm安装项目依赖
• 子模块维护：提供子模块初始化、更新及同步脚本
• 环境配置：使用env-cmd管理不同环境的环境变量
• Docker集成：支持Docker Compose部署配置，包含环境变量注入
• 开发便捷工具：提供热重载开发、代码格式化等实用脚本

使用场景

适用于Node.js项目的本地开发环境搭建，尤其适合需要管理Git子模块、多环境配置及依赖频繁更新的开发场景。

使用方法

1. 环境准备

安装依赖

bash
npm i

初始化Git子模块

bash
git submodule update --init

子模块故障排除：若子模块出现问题，尝试清理.git/config中的子模块配置

保持子模块更新

bash
npm run pull-submodules

2. 环境变量配置

使用env-cmd管理环境变量，创建对应环境的.env文件（如开发环境使用.env.develop）。建议在项目中通过.gitignore忽略.env*文件。

3. Docker Compose配置

在Docker Compose文件中集成环境变量，示例配置：

yaml
version: {versionNum}
services:
  {ServiceName}:
    image: {org}/{dockerhub_img_name}:latest-dev
    hostname: {hostname}
    environment:
      {ENVVAR1}: "{val1}"
      {ENVVAR2}: "{val2}"
      {ENVVAR3}: "{val3}"

可用脚本

脚本列表

• prebuild
• build
• prestart:develop
• start:develop
• dev
• pull-submodules
• fix

常用脚本说明

npm run start:develop

• 触发完整构建流程：依次执行prestart:develop → build → prebuild
• 适用于完整构建并启动开发环境

npm run dev

• 使用ts-node-dev实现热重载开发
• 无需手动重建，代码变更后自动重启服务
• 注意：若出现错误，需重新运行该命令

npm run pull-submodules

• 对所有子模块执行git checkout develop和git pull
• 用于同步最新的子模块代码

npm run fix

• 使用prettier（带--write选项）格式化src目录下所有.ts、.js、.json文件（递归处理）
• 统一代码风格，修复格式问题