Skip to main content

Creating a new IrisX App

In this step, we will create a new app in the workspace. An app is the deployable unit that will contain all the extensions and configurations.

1. Use the App SDK to generate your first IrisX App​

npx nx generate @trackunit/iris-app:create [name-of-your-app]

Note: If you did not use the @trackunit/create-iris-app-workspace CLI to generate your workspace, you must add the App SDK first by executing:

npm install @trackunit/iris-app

2. A confirmation message will appear confirming that the command was successful.​

UPDATE package.json
CREATE .npmrc
CREATE apps/app/assets/description.md
CREATE apps/app/eslint.config.cjs
CREATE apps/app/iris-app-manifest.ts
CREATE apps/app/package.json
CREATE apps/app/tsconfig.app.json
CREATE apps/app/tsconfig.json
CREATE apps/app/tsconfig.spec.json
CREATE apps/app/vite.config.ts
CREATE apps/app/project.json

3. Your first IrisX App will be In the apps folder.​

⊢ apps
   ⊢ [name-of-your-app]/
      ⊢ assets/
      ⊢ eslint.config.cjs
      ⊢ iris-app-manifest.ts
      ⊢ package.json
      ⊢ project.json
      ⊢ tsconfig.app.json
      ⊢ tsconfig.json
      ⊢ tsconfig.spec.json
      ⊢ vite.config.ts
   ⊢ .gitkeep

The app has no src/ folder yet — that appears when you add your first extension in the next step.

Next you should extend your IrisX App with an extension to actually add some content.