Skip to main content

Creating a workspace

To set up an empty NX workspace follow the steps below. If you're unfamiliar with NX, check out NX.dev.

1. Run the command below to create an nx workspace for all your IrisX Apps:​

npx @trackunit/create-iris-app-workspace <name-of-your-workspace>

2. Go into your NX Workspace folder​

cd <name-of-your-workspace>

You now have a NX Workspace and are ready to create your first IrisX App!

npm release-age policies

If your organization enforces an npm release-age policy (min-release-age or before), workspace creation respects it automatically: npx already resolves to a CLI release old enough to satisfy the policy, and that release installs an exact, matching @trackunit/iris-app version rather than resolving latest from the registry. You don't need to configure anything extra for this.

Trackunit linting included

New workspaces come with Trackunit's ESLint rules set up for your apps and extensions. Once you have created some, lint them all from the workspace root:

npx nx run-many -t lint

Created your workspace before Trackunit linting was added (there's no eslint.config.cjs at the workspace root)? Follow Linting to set it up in an existing workspace.