Skip to content
FrameKit Docs

Create a project

Use the official creator when you are starting a new application.

Prerequisites

Section titled “Prerequisites”
  • Node.js >=22.13.0.
  • pnpm >=11.14.0 when using pnpm.
  • A destination directory that does not already exist.

Create and run the project

Section titled “Create and run the project”

  1. Create the application.

    Terminal window
    pnpm dlx @mauriciodmo/create-framekit my-project

  2. Enter the project and start development.

    Terminal window
    cd my-project
    pnpm dev

  3. Open Studio.

    Visit http://localhost:3000. New projects use open mode by default: the application redirects to /editor, and /editor and /brand work without login. /login redirects to /editor. To enable login and protected access, set FRAMEKIT_AUTH_ENABLED=true; only in that mode set FRAMEKIT_ADMIN_PASSWORD before the first login. FRAMEKIT_ADMIN_USERNAME is optional and defaults to admin.

  4. Create your first template.

    Continue with Create your first template.

Creator options

Section titled “Creator options”

The creator can install dependencies, run pnpm build-script approval, initialize Git, accept or reject prompts non-interactively, and refresh public FrameKit skills. Those switches are reference material rather than required setup steps.

See the create-framekit CLI reference for prompts, -y, -n, update-skills, and recovery when installation is skipped or fails.