Files
MineGeo/docs/vercel-deployment.md

1.3 KiB

Deploy MineGeo

Run npm run deploy from the project directory. The script collects all web source files and public assets, uploads them in one request, waits for the build, and prints the deployment URL. It uses the Vercel deployments API. The database credentials already configured in Vercel remain there. The Minecraft rendering worker stays on its current host.

The script excludes Git metadata, local environment files, caches, generated captures, tests, Java build sources, and development tools. It checks uploaded content, including the downloadable JARs, for references to the Git server. Nothing is pushed to Gitea or connected to a Git provider.

Authentication is needed once: run vercel login, or put a Vercel token in the ignored .env.deploy.local file as VERCEL_TOKEN=.... The Codex Vercel plugin's login does not sign the local script in. Tokens are never included in the upload or command output.

Useful options:

  • npm run deploy -- --dry-run: inspect file count and the privacy check without uploading.
  • npm run deploy -- --preview: create a preview deployment.
  • npm run deploy -- --help: show usage.

The script targets the existing MineGeo project. Set VERCEL_PROJECT_ID and VERCEL_ORG_ID to deploy a copy to another Vercel project.