Skip to main content

@krakentech/create-blueprint-foundation

Use this package to scaffold the Foundation starter app with one command:

pnpm dlx @krakentech/create-blueprint-foundation my-app

Make sure npm auth for private @krakentech packages is already available before running the command. The scaffolder runs pnpm install, but it never writes npm tokens or copies a real .npmrc.

Use a user-level .npmrc, a parent-directory .npmrc, or copy .npmrc.example to .npmrc in the project root. The file must contain a token that can install private @krakentech packages.

//registry.npmjs.org/:_authToken=YOUR_NPM_TOKEN

Options​

  • --package-name <name>: set package.json name in the scaffolded project
  • --app-name <display-name>: set the app display name in src/app.config.ts
  • --ci: non-interactive mode (requires target-dir, --package-name, and --app-name)

What it writes​

  • copies the vetted Foundation template snapshot,
  • updates non-secret project metadata,
  • writes blueprintFoundation metadata to package.json,
  • runs git init and pnpm install,
  • keeps .npmrc.example and never writes npm tokens.

After scaffolding​

Enter the generated app and follow these steps:

1. Configure npm authentication​

cd my-app
cp .npmrc.example .npmrc

Open .npmrc and add your npm authentication token.

2. Install dependencies​

pnpm install

3. Configure environment variables​

cp .env.example .env.local

Open .env.local and set these required values:

KRAKEN_GRAPHQL_ENDPOINT
KRAKEN_AUTH_ENDPOINT
KRAKEN_OAUTH_CLIENT_ID
KRAKEN_X_CLIENT_IP_SECRET_KEY

4. Generate GraphQL types​

pnpm generate

5. Start the development server​

pnpm dev

Set all four listed environment variables in .env.local before running pnpm generate.

npm auth requirements​

The npm token used by external clients needs read access to:

  • @krakentech/create-blueprint-foundation
  • each private @krakentech/* package required by the scaffolded Foundation app

Supported command matrix:

pnpm dlx @krakentech/create-blueprint-foundation <project-dir>
pnpm install

If pnpm install fails with ERR_PNPM_FETCH, verify the token has access to all required private packages and that .npmrc is configured.