Skip to main content
Public package sources and releases live in magic-resume-kit. Source paths and package build commands for schema, templates, design-system, icons, utils and MCP on this page refer to that repository. Applications consume @magic-resume-kit/* from npm. After cloning the Magic-Resume repo and running pnpm install, run pnpm run dev from the repo root to start each workspace’s dev script in parallel through Turbo. Use pnpm run lint and pnpm run test for the full quality checks. If you have not set up the repo yet, start at Self-Hosted.

How is the repository organized?

How do I set up my editor?

The repo is TypeScript end-to-end. The recommended editor setup:
  • VS Code with the ESLint and TypeScript Nightly extensions, or
  • Cursor / Windsurf / Claude Code — all three know how to read CLAUDE.md and the workspace TS configs.
pnpm-workspace.yaml and packages/tsconfig mean type-checking works across workspaces with no extra config. If your editor doesn’t find a type, restart its TS server.

How does hot reload work across workspaces?

pnpm run dev from the repo root runs every workspace’s dev script in parallel through Turbo. Most workspaces are watch-mode: Public package changes must be built and published from magic-resume-kit, then adopted by updating exact versions here; they are no longer local workspace links.
Next.js 16 uses Turbopack for dev by default. Use pnpm --filter @magic-resume/web dev:webpack when Webpack is needed.

How do I run lint and tests before committing?

lint-staged (configured in the root package.json) runs on staged files via Husky, but the full sweep is:
The apps/web workspace has an i18n check that fires on staged .tsx/.ts files:
This validates that every new translation key is present in every locale. Adding a key in en.json without adding it in zh-CN.json will fail the pre-commit hook.

What are the branch and commit conventions?

The default branch is master. Feature branches use <type>/<short-name> (e.g. feat/turborepo-mcp-migration-wip). Commits follow conventional-commit style — see git log for examples.