The best way to control Claude Code, Codex and more from any computer or phone

main
ts 44 lines 1.4 KB
Raw
1 import { frameworkSite, type FrameworkSiteProps } from "./FrameworkSite.ts";
2
3 /** The framework-integration package that drives the Octane build. */
4 export const OCTANE_FRAMEWORK_SPECIFIER = "@alchemy.run/frontend-frameworks/octane";
5
6 /** The Node container deploy target for the Octane build. */
7 export const OCTANE_NODE_TARGET_SPECIFIER = "@alchemy.run/frontend-frameworks/octane/node";
8
9 export interface OctaneProps extends FrameworkSiteProps {}
10
11 /**
12 * Deploy an [OctaneJS](https://octanejs.dev) application to Fly: Octane's
13 * SSR server on a Machine, static assets baked into the image.
14 *
15 * `Fly.Website.Octane` selects hosting and automatically wraps Octane's
16 * default native Node output. Keep compiler and route settings in
17 * `octane.config.ts` without an adapter. The legacy Node marker adapter
18 * remains optional for existing projects.
19 *
20 * ### Creating Octane Sites
21 * **Example:** Basic Octane App
22 * ```typescript
23 * const site = yield* Fly.Website.Octane("Web", {
24 * rootDir: "./app",
25 * });
26 * ```
27 *
28 * **Example:** Custom Domain
29 * ```typescript
30 * const site = yield* Fly.Website.Octane("Web", {
31 * rootDir: "./app",
32 * domain: "app.example.com",
33 * });
34 * ```
35 *
36 * @resource
37 * @product Website
38 */
39 export const Octane = (id: string, props: OctaneProps = {}) =>
40 frameworkSite(id, props, {
41 name: "Octane",
42 framework: OCTANE_FRAMEWORK_SPECIFIER,
43 target: OCTANE_NODE_TARGET_SPECIFIER,
44 });