用途:指导在本地运行 Nango 进行开发与浏览器测试。Nango 由多个微服务(server、webapp、jobs、persist、orchestrator、metering、connect-ui)组成,依赖 Docker 容器(PostgreSQL、Redis、Elasticsearch、ActiveMQ),需要两个终端:一个做 TypeScript 监视构建,一个运行服务。
主要能力与启动步骤:先 npm install(切换分支或拉取后必须执行),若根目录无 .env 则复制 .env.example 并加入 NANGO_ENCRYPTION_KEY(openssl rand -base64 32 生成)、FLAG_AUTH_ENABLED=true,可选 FLAG_AUTH_ROLES_ENABLED=true;然后 npm run dev:docker 启动依赖;终端 1 运行 npm run dev:watch(别名 dw),终端 2 运行 npm run dev:watch:apps(别名 dwa)。前端工作用 dev:watch:web,后端用 dev:watch:headless。也可单服务启动,如 npm run server:dev:watch、webapp:dev:watch、connect-ui:dev:watch、jobs:dev:watch、persist:dev:watch、orchestrator:dev:watch、metering:dev:watch。
服务地址:Webapp http://localhost:3000、API Server http://localhost:3003、Connect UI http://localhost:3009、PostgreSQL localhost:5432(用户/密码均为 nango)、Redis localhost:6379、Elasticsearch http://localhost:9500、ActiveMQ Console http://localhost:8161。
使用方式与限制:浏览器测试可用标准测试凭据(Test User / test@nango.dev / TestPassword123!)。可用 SQL 查询 _nango_users 判断登录或注册;本地不实际发邮件,验证链接在服务端日志中以 (EmailClient) 前缀输出,可用 grep 'signup/verification' 查找。多 worktree 可用 REMOTE_API=dev|staging|prod 代理到远程 API。设置 NANGO_CLOUD=true 会禁用本地功能标志并改变 CORS、管理路由等行为,本地应保持未设置。重置数据库是破坏性操作,需先确认,且因 PostgreSQL 用绑定挂载,docker compose down -v 不会重置数据库;需手动 DROP SCHEMA 并重启服务,之后需重新注册。迁移文件缺失会导致启动失败,可用 NANGO_MIGRATE_AT_START=false 跳过或清理迁移记录。资料未提供具体产品流程示例(标注为待补充)。