@trackunit/iris-app
v2.4.2
Published
The `@trackunit/iris-app` package is a plugin for [NX by @nrwl](https://nx.dev/). This plugin adds some helpful generators used to set up a Trackunit Iris App project.
Downloads
11,664
Keywords
Readme
Trackunit Iris App SDK
The @trackunit/iris-app package is a plugin for NX by @nrwl.
This plugin adds some helpful generators used to set up a Trackunit Iris App project.
Trackunit Iris App SDK are used by developers to integrate custom functionality into the Trackunit Manager platform.
For more info and a full guide on Iris App SDK Development, please visit our Developer Hub.
Getting started
Run through the easy getting started guide here: Getting Started
Serverside GraphQL scaffolding
Typed access to the Trackunit public GraphQL API is optional for serverside API extensions:
npx nx generate @trackunit/iris-app:extend \
--type=SERVERSIDE_API_EXTENSION \
--graphqlThe option is off by default. It reuses the standard graphql-hooks target, configures React-free code generation against the public schema, and adds a named typed asset query example. Regenerate documents after editing .graphql files:
npx nx run <project>:graphql-hooksLocal requests must include a user bearer token. Set SDK_ENVIRONMENT=DEV or STAGE in the extension's .env to target a non-production public API; unset defaults to production.
Testing Local Changes
To test changes to the SDK generators locally, you can verify them in a full, temporary workspace environment.
Command:
yarn run integration-test
What it does:
- Generates a temporary workspace containing a full Iris app setup.
- Allows you to open this temporary workspace in your IDE.
- Enables you to verify that your changes to generators or other SDK components work as expected in a real environment.
How to open:
Look for the phrase Successfully created the workspace: in the console output, then command-click the path to open the workspace.
Trackunit
This package was developed by Trackunit ApS. Trackunit is the leading SaaS-based IoT solution for the construction industry, offering an ecosystem of hardware, fleet management software & telematics.
