Integrating Atrium into an application

A consumer is your application’s frontend using Atrium. Your application owns its pages, routes, branding, session, API adapters, and deployment. Atrium supplies reusable presentation and interaction.

Choose the entry point matching your needs. All packages are installed from the Atrium GitLab project’s remote npm registry. Configure registry access once using the end-to-end walkthrough.

Package	Intended use	Next step
@agon/atrium-starter.	Start with a minimal working frontend.	Run yarn atrium-starter publish.
@agon/atrium-showcase.	Start with the full demonstration application and component catalogue.	Run yarn atrium-showcase publish.
@agon/atrium.	Assemble or integrate the frontend yourself.	Configure your build, shell, pages, and services.
@agon/atrium-publisher.	Shared infrastructure used by the starter and showcase commands.	Installed automatically with either template.

The two application packages depend on both @agon/atrium and @agon/atrium-publisher. Their local publication command creates the editable project and installs its build dependencies. You do not clone the development monorepo or pack an archive for normal integration.

Reading path

1. Follow end-to-end application integration from registry access through project creation and deployment.
2. Read local publication for previewing changes, conflict handling, and package ownership after initialization.
3. Add your first page and select components from the component guides.
4. Implement backend and session integration and configure theming, build defaults, and settings-panel availability.
5. Complete deployment and upgrades, including production acceptance and your application’s CI.

Experienced developers and existing applications

Install the core package directly when you want to own bootstrap and configuration:

yarn init
yarn add @agon/atrium

For an existing frontend, keep its manifest and omit yarn init. This installs the reusable library only. You supply the application entry points, compatible build dependencies, and runtime configuration. Start with the manual bootstrap guide and component contracts.

Atrium’s shipped integration uses Vite, Alpine’s CSP runtime, and Bootstrap Sass. Integrating an existing framework router, a backend-rendered shell, or another bundler requires application-specific work. The maintained walkthrough covers a standalone SPA.

Development workspaces and released packages

Inside the Atrium repository, four Yarn workspaces let maintainers develop the library, publisher, starter, and showcase together. Internal workspace:* dependencies are converted to exact released versions when Yarn packs the packages. The private repository root is not released.

Applications install published versions from the registry. Maintainer tests install local archives to verify unreleased changes before publication. That archive workflow lives in maintainer verification.

The word publish has two explicit contexts in these docs. An application’s atrium-starter publish or atrium-showcase publish writes local project files. The hosted GitLab release pipeline publishes package versions to the registry. Running a template command never uploads a package.

Author

Laurent Declercq l.declercq@agon-innovation.ch

License

Unless otherwise stated all source code is licensed under LGPL 2.1 and has the following copyright:

© 2026, Agon Partners Innovation AG, All rights reserved.

The design material and the “Agon Ātrium” trademark is the property of their authors. Reuse of them without prior consent of their respective authors is strictly prohibited.

Version

Version: 20260921