serinus_inertia 0.1.0

Serinus adapter package for the Inertia.js Dart server protocol

example/README.md

Serinus Inertia Example

This example is a complete Serinus + Inertia + Vite setup.

Getting Started

If you want the shortest path from clone to browser, use this sequence.

1. Install dependencies

Install the Dart packages:

dart pub get

Install the client packages:

cd client
npm install

2. Start development mode

Run Vite in one terminal:

cd client
npm run dev

Run the Serinus app in a second terminal:

dart run bin/main.dart

Then open http://127.0.0.1:4000.

Dev server discovery

The example uses a single Vite hot file at client/public/hot.

In development the server resolves client assets in this order:

1. devServerUrl if you set one in lib/app_module.dart
2. the hot file at client/public/hot
3. the production manifest if neither dev option is available

If you run Vite on a custom port and do not want to rely on the hot file, set:

assets: SerinusInertiaAssetOptions(
  entry: 'src/main.jsx',
  clientDirectory: 'client',
  devServerUrl: 'http://127.0.0.1:5174',
),

If your toolchain writes the hot file somewhere else, override hotFile in the same asset options block.

What It Covers

The demo is intentionally broader than a hello-world app so the adapter can be exercised properly.

• / is a launchpad that explains the available drills.
• /users tests remembered history state, query-param server filters, and a lazy prop loaded through partial reloads.
• /lab concentrates deferred props, optional props, merge props, scroll props, polling, flash payloads, history flags, and a post-action redirect.

Project Layout

• lib/app_module.dart registers InertiaModule
• lib/app_controller.dart defines the demo routes
• client/src/main.jsx is the client bootstrap
• client/src/ssr.jsx is the SSR entry
• client/src/Pages/ contains the demo pages

Suggested Manual Checks

Once the app is running, use these routes to shake out the adapter behavior.

Users page

• Change the team filter and confirm the server-side roster changes.
• Type in the client-side search box, leave the page, then use browser back/forward navigation to confirm the remembered state is restored.
• Load the lazy diagnostics panel and confirm the rest of the page state stays in place.

Feature lab

• Wait for the live stats cards to poll fresh data.
• Scroll until the deep dive section loads its optional prop.
• Watch the deferred release timeline resolve after the initial paint.
• Load more highlight batches, then reset them to confirm merge reset behavior.
• Scroll the activity feed until the next page loads.
• Trigger the post action and confirm the redirect arrives with flash data.
• Toggle the history buttons and inspect the page metadata panel.

Optional SSR

You can run SSR in either of two ways.

Managed by Serinus

Build the SSR bundle:

cd client
npm run build:ssr

Then enable this in lib/app_module.dart:

ssr: SerinusInertiaSsrOptions(
  enabled: true,
  manageProcess: true,
  runtime: 'node', // or 'bun'
  bundle: 'client/dist/ssr.js',
),

Now dart run bin/main.dart will start Serinus and launch the SSR runtime as a separate child process.

Managed Separately

Build the SSR bundle:

cd client
npm run build:ssr

Start the SSR server manually from the package executable:

dart run serinus_inertia:ssr start --bundle client/dist/ssr.js

Then enable the endpoint-based ssr: section in lib/app_module.dart.

Production Build

Build the client bundle:

cd client
npm run build

Then start the Serinus server normally:

dart run bin/main.dart

The example server will read the Vite manifest from client/dist/.vite/manifest.json.