Containing the A12 Overview Engine package, migration tool, and interactive showcase applications for building data-driven overview interfaces with React.
Refer to https://geta12.com/#/docs to get started with A12 development
Parts of the A12 platform are made available under a dual license. Please check the LICENSE file for details.
To use the Overview Engine in your project:
npm install @com.mgmtp.a12.overviewengine/overviewengine-coreThe following tools are required in order to build this repository:
| Tool | Version |
|---|---|
| JDK | 21 |
| Node | 24.x |
| pnpm | 10.x |
| Gradle (optional) | 8.x |
Install all dependencies and link local packages:
pnpm installBuild all packages:
pnpm compileThis will execute the build in all packages, which includes:
- Compiling TypeScript source in
corefolder and others to JavaScript - Bundle the showcase using Rsbuild
- Generate documentation
Run unit tests in all packages:
pnpm testRun end-to-end tests (require the dev servers to be running via pnpm start):
pnpm testE2EStart the development environment:
pnpm startThis will start the dev servers and TypeScript compilers in watch mode. This is the recommended way to start developing instead of starting individual packages.
For IntelliJ users, the compound task 'Start - All' can be run to execute all of them separately.
Once running, open your browser and navigate to:
- Showcase: http://localhost:12000
- Documentation:
documentation/build/index.html(after compile) - TypeDoc:
documentation/build/assets/generated/typedoc/index.html(after compile)
Remove all build artifacts:
pnpm cleanRun linting:
pnpm lintFix linting issues:
pnpm format- Full technical documentation is available at GetA12.com.
- The website also provides access to the A12 Discourse Community Forum.
The mgm A12 Team