Forge Project Init

Forge Project Init

Purpose

Turn this repository into a clean, independently developable project:

• Code: renamed packages, artifacts and frontends, with only the selected modules.
• Project context: AGENTS.md, .agents/skills, and code-copilot rules, memory and knowledge are kept. code-copilot/changes starts empty, with no history and no unarchived changes.
• Database: only the default tenant, the super admin (with its role and root org), menus/permissions, dictionaries, configs, regions, job configs, built-in templates and the Flyway history table are kept.

Details of the database rules: code-copilot/changes/db-clean-template-init/spec.md in the template repo.

Workflow

1. Generate code (forge:create)

Run from the template repo root:

pnpm forge:create -- ../<project-dir> \
  --preset full \
  --base-package com.company.project \
  --display-name 系统中文名 \
  [--java-name ProjectName] [--database-name project_db] [--include business-core]

• Presets: minimal-admin, data-app, ai-report, full. See scripts/forge-create/module-catalog.json.
• full includes admin UI, report UI, H5 (<project>-h5-ui) and Docker deploy (docker-<project>). Other presets can add them with --include h5-ui,docker; H5 pulls in app-server + flow-server, Docker pulls in admin-server + flow-server + admin UI.
• Renames:
  • com.mdframe.forge becomes the new package / groupId.
  • forge-* artifacts and directories get the new prefix.
  • forge_admin becomes the new database name.
  • forge_schema_history becomes <snake>_schema_history, consistently in application.yml, the full SQL, the Flyway runner and clean-db.sh.
  • H5: /forge-h5 and /forge-h5-api become /<project>-h5 and /<project>-h5-api; the client ID forge_h5 becomes <snake>_h5, in the .env files and in sys_client in the full SQL.
  • Docker:
    • nginx.conf and Dockerfile.ui are rewritten to the generated admin public path and API prefix (defaults / and /api);
    • service, container and network names use the project name;
    • init-sql/01-init.sql is overwritten with the generated full SQL.
• Not copied:
  • .git, node_modules, target, logs;
  • application-dev.yml, .env.local, docker-forge-admin/.env;
  • code-copilot/changes;
  • db/backup (old migrations already folded into the full SQL) and db/community-export.
• Default: ask for the module preset, base package, display name and database name if the user has not given them. Do not guess.

2. Local config (in the generated project)

cp <prefix>-server/<prefix>-admin-server/src/main/resources/application-dev.example.yml \
   <prefix>-server/<prefix>-admin-server/src/main/resources/application-dev.yml
cp <prefix>-admin-ui/.env.example <prefix>-admin-ui/.env.local

• Fill in the MySQL and Redis settings.
• If the flow server is included, copy its example config the same way. It uses the same database.
• Never commit real passwords.

3. Clean database

Needs a mysql client, Maven and MySQL 8. Run from <prefix>-server:

MYSQL_PWD=*** bash scripts/db/init-db.sh --database <db> --recreate --clean

This runs: recreate the database → full SQL → required seed → Flyway migrations → clean-db.sh.

Without Maven:

1. Run init-db.sh --database <db> --recreate.
2. Start the admin server once so Flyway migrates.
3. Run clean-db.sh --database <db> to preview.
4. Add --execute to clean.

With Docker:

1. In docker-<project>, run cp .env.example .env && docker compose up -d. MySQL imports the full SQL; admin runs Flyway.
2. Once admin is up, run MYSQL_PWD=*** bash <prefix>-server/scripts/db/clean-db.sh --host 127.0.0.1 --database <db> --execute.
3. Run docker compose restart <module-prefix>-admin so caches reload.

4. Verify

• mvn -pl <prefix>-admin-server -am compile -DskipTests, and pnpm install && pnpm build in the admin UI (and in the H5 UI if generated).
• The database has one row each in sys_user, sys_tenant and sys_role. ACT_RU_TASK is empty. sys_job_config is not empty.
• Start admin: Flyway reports the schema is up to date. admin / 123456 logs in, no low-code app menus appear, and a file upload works with local storage.
• ls -a code-copilot/changes shows only .gitkeep.
• Then run git init in the new project and make the first commit.