Aurelia docs
Installation
Aurelia can start as a contained hosted layer or as a deeper React integration. The current prototype already exposes both a provider-based shell and a host-page init contract, which makes it practical to pilot on a hotel website without rebuilding the whole stack.
Product, engineering, and technical stakeholders preparing a first integration.
6 min
Install Aurelia on a hotel website by choosing the right launch model, wiring page context, and placing the first prompt surfaces.
Install Aurelia on a hotel website
Aurelia does not require a full-site rebuild to launch on a hospitality brand website.
The practical install path for a hotel website is straightforward: mount the Aurelia shell, provide page context, add a few high-intent launch points, and capture the event stream. That can begin as a lightweight pilot on homepage, destination browse, hotel detail, and booking handoff surfaces before any deeper integration work is justified.
- Mount the assistant once at the application root or initialize it from the host page.
- Pass the page type, visible hotels, and active hotel so answers stay grounded to the current browsing context.
- Add launch points in the homepage hero, hotel cards, hotel detail pages, and the booking handoff.
- Capture launch, prompt, answer, and handoff events so the pilot produces usable learning.
For a first launch, the hotel website mainly needs a place to mount the shell, a small context contract, and a few deliberate prompt surfaces. It does not need a full redesign or a separate search stack on day one.
Choose a launch model
Pilot first, then deepen the integration as the program matures.
Aurelia supports two practical launch modes for hospitality teams. The first is a light-touch pilot that mounts a hosted concierge layer over the existing website. The second is a deeper product integration where the brand owns placement, prompt surfaces, page context, and the booking handoff more explicitly.
- Hosted pilot: quickest path for a proof with homepage, browse, hotel detail, and booking handoff coverage.
- Embedded React integration: best when the brand wants tighter UI control, richer page context, and reusable prompt components.
- Phased rollout: start with high-intent surfaces, validate guest behavior, then expand to destination pages, campaigns, and repeat-guest flows.
| Launch model | Best for | Host responsibilities |
|---|---|---|
| Hosted pilot | Fast proof on a live hotel website with minimal product rewiring | Load the shell, pass page context, place prompt surfaces, and capture telemetry |
| Embedded React integration | Brands that want tighter UI control and deeper product ownership | Wrap the app with the provider, wire launchers into product code, and manage richer context updates |
| Phased rollout | Large groups that want to prove value before expanding across the portfolio | Start with flagship routes, review the event stream, and widen coverage only after the core journeys are stable |
The repo already exposes a working provider-based shell and a window host API. The docs below describe that current prototype surface rather than inventing a future SDK that does not exist yet.
Mount the shell in Next.js or React
Wrap the application once so Aurelia can open from any supported page.
In the current prototype, the fastest internal install path is to wrap the app with the exported provider. That keeps the assistant shell available to homepage, browse, hotel, and booking routes without forcing each page to own chat state independently.
Wrap the app once so the concierge shell can be launched from any route.
import { PreferredConciergeProvider } from "@/components/concierge-embed";
export default function RootLayout({
children,
}: Readonly<{ children: React.ReactNode }>) {
return (
<html lang="en">
<body>
<PreferredConciergeProvider>{children}</PreferredConciergeProvider>
</body>
</html>
);
}- Keep the provider at the root layout so navigation preserves conversation state.
- Use route-specific page context so the assistant knows whether the guest is on homepage, destination, hotel, or booking surfaces.
- Treat the visual shell as a product layer, not a one-off modal, so prompt surfaces can be reused consistently.
For a hospitality site, this is usually the best path when the web team already controls the application shell and wants Aurelia to feel native to homepage, browse, hotel, and booking views.
Initialize from the host page
Use the exposed host API when Aurelia is controlled by a parent site or CMS.
The prototype also exposes a host-page contract for sites that want a lighter integration surface. The host can initialize Aurelia, resolve page context dynamically, and open the assistant from CMS-managed prompts or page-specific controls.
Reference host contract used by the current prototype shell.
window.PreferredConcierge?.init({
apiBaseUrl: "/api",
siteKey: "preferred-hotels-pilot",
brandMode: "aurelia",
locale: "en-US",
currency: "USD",
resolvePageContext: () => ({
id: "aurelia-home",
pageType: "homepage",
promptSuggestions: [
"Quiet anniversary stay",
"Best time to visit Greece",
"Late arrival"
]
}),
onEvent: (event) => {
console.log("Aurelia event", event);
}
});The host does not need to own answer generation, retrieval, or orchestration logic. It mainly provides brand context, page context, analytics hooks, and the desired launch points.
What the host website needs to provide
Keep the contract small and explicit so rollout remains practical.
| Input | Why it matters | Typical source |
|---|---|---|
| Page type | Changes answer behavior between planning, hotel evaluation, and booking support | Router or page template |
| Visible hotel set | Keeps shortlist and compare answers grounded to what the guest can actually see | Browse page state |
| Active hotel slug | Pins hotel-specific follow-ups to the current property | Hotel detail page |
| Prompt suggestions | Shapes the first-turn experience around the current journey stage | Product config or CMS |
| Event hook | Lets the host measure launches, prompts, follow-ups, and handoffs | Analytics layer |
Pilot checklist
The minimum viable integration for a high-credibility first launch.
- Mount the shell
Install the provider or hosted init contract so Aurelia can open reliably across supported routes.
- Define page context
Pass page type, visible hotels, hotel slug, and section context so the assistant stays grounded to where the guest is browsing.
- Add prompt surfaces
Place launchers in the homepage hero, hotel cards, hotel detail pages, and booking handoff screens.
- Review analytics and guardrails
Track launches, prompts, follow-up depth, rate handoff clicks, and any answer gaps before expanding site-wide.