Skip to content
Agon ĀtriumAgon Ātrium

Source code

Open source page

Manual bootstrap with the core library

Use @agon/atrium directly when integrating an existing frontend or assembling its bootstrap yourself. This package contains reusable components, styles, templates, locales, and build helpers. It does not generate application files. For an initialized project, use starter or showcase publication.

Install and configure

Configure the registry using the integration walkthrough, then run yarn add @agon/atrium in your application. Use Node 24 and the release’s pinned Yarn version. Give your manifest type: module and install the build dependencies compatible with the selected release. For the current release:

Terminal window
yarn add --dev vite@8.3.0 sass@1.104.1 postcss@8.5.28 postcss-rtlcss@6.0.0

Set application scripts for Vite development, vite build --mode production, vite build --mode development, and Vite preview. Declare a private application manifest and keep its generated lockfile. The complete starter Vite configuration is a reference when integrating the following pieces into your own layout.

Required integration pieces

  • Define routes with application-relative HTML templates and optional lazy controller modules. Keep one root element in each page template.
  • Add adminHtml({ root, routes, appearance }) and adminBuild({ mode, minify }) from @agon/atrium/vite to your Vite configuration. Set root to the directory containing your application templates. Define optional appearance settings as described in the build configuration guide.
  • Configure postcss-rtlcss as in the starter so Bootstrap’s directional styles support RTL.
  • Import @agon/atrium/theme from your application Sass file and import that file from your JavaScript entry point.
  • Compose <include src="ui:shell.html"></include> in the entry document and load your JavaScript through an external module script. Include <include src="ui:startup.html"></include> in <head> for the initial loading state and global progress line.
  • Import createAdmin, your routes and messages, pages from virtual:atrium/pages, and appearance from virtual:atrium/appearance. Pass both generated objects to createAdmin. Supply branding, a unique preference namespace, session, navigation groups, and service context as described in component contracts.
  • Set the runtime base to import.meta.env.BASE_URL and call the returned application’s start() once. Coordinate any existing Alpine bootstrap so it does not start a second runtime.

Use the starter entry document and composition root as source references for the selected release. Replace demonstration identities and messages with application-owned settings. Keep Bootstrap JavaScript away from controls owned by Alpine.

Application responsibilities

Implement the backend and session contracts, configure theming, and follow deployment and acceptance. The package supplies neither authentication endpoints nor business logic. Existing-framework or backend-rendered integrations need their own lifecycle, asset, and routing checks.

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