Skip to main content

Install a Foundation app

Prerequisites​

Before running the scaffolder, make sure you have:

  • Node.js 24
  • pnpm
  • Git

1. Set up npm registry credentials​

Do this before running the scaffolder. The scaffolder and generated app depend on private @krakentech packages, and the scaffolder runs pnpm install automatically.

To use the scaffolder's automatic dependency installation, configure the token in your user-level ~/.npmrc:

//registry.npmjs.org/:_authToken=${NPM_TOKEN}

Set NPM_TOKEN through your local credential tooling or shell environment. Never commit the token. It is provided by Kraken Technologies, typically through your Client Delivery Lead during initial Kraken setup, and rotated periodically.

2. Scaffold the app​

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

The scaffolder initializes Git and installs dependencies in the generated app.

An .npmrc in the parent directory is not used when the scaffolder runs pnpm install inside the generated app. If you need project-local credentials instead of user-level credentials, skip the automatic install:

pnpm dlx @krakentech/create-blueprint-foundation my-app --skip-install
cd my-app
cp .npmrc.example .npmrc
# Add the token to .npmrc, then:
pnpm install

Valid npm registry credentials are still required to download the private scaffolder itself.

3. Set up environment variables​

Copy .env.example to .env.local and set these required values before running pnpm generate:

  • KRAKEN_GRAPHQL_ENDPOINT
  • KRAKEN_AUTH_ENDPOINT
  • KRAKEN_ACCESS_TOKEN_ISSUERS
  • KRAKEN_OAUTH_CLIENT_ID
  • KRAKEN_X_CLIENT_IP_SECRET_KEY

4. Use the required Node.js version​

The generated Foundation app includes a .nvmrc, so you can run nvm use to make sure you're using the right version.

5. Recover from a failed dependency install​

If the scaffolder's pnpm install step failed, do not rerun the scaffolder. The app directory already exists. Fix the reported problem, enter the generated app, and rerun the install there:

cd my-app
pnpm install

If pnpm is unavailable, enable Corepack first:

corepack enable
pnpm install
note

You'll have to do this once every time you use a node version for the first time.

Troubleshooting

If you see an ERR_PNPM_FETCH error when running pnpm install, it is likely due to a missing or invalid token. Check that npm can read the .npmrc containing the correct token. If you need help obtaining it, reach out on the #cust-web-blueprint-feedback Slack channel.

You should now be ready to configure the Foundation app, including the required Kraken environment variables, and then run it locally!