sailfork / t3code-github / .repos/ alchemy-effect/ packages/ railway/ src/ Website/ Nextjs.ts

import * as Namespace from "alchemy/Namespace";
import { makeFrameworkSite, type FrameworkSiteProps } from "./FrameworkSite.ts";

/**
 * The Next.js Node framework module (it is its own deploy target — not
 * OpenNext). Container-optimal path is `next build` + a long-running Node
 * process.
 */
export const NEXTJS_FRAMEWORK_SPECIFIER = "@alchemy.run/frontend-frameworks/nextjs/node";

/** The Node container deploy target for the Next.js build. */
export const NEXTJS_NODE_TARGET_SPECIFIER = "@alchemy.run/frontend-frameworks/nextjs/node";

export interface NextjsProps extends FrameworkSiteProps {}

/**
 * Deploy a Next.js application to Railway as a long-running Node process:
 * `next build`, then a serve entry that `import("next")` +
 * `next({ dev: false }).prepare()` + `getRequestHandler()` on `PORT`
 * (default 3000). **Not** OpenNext — those wrappers are Lambda/workerd.
 *
 * The image `npm install`s `next`, `react`, and `react-dom`, and bakes
 * `.next` plus `public/` into `/app`.
 *
 * During `alchemy dev` the site is Next's own dev server (`next dev`) and
 * no cloud resources are declared; `Alchemy.remote()` opts back into the
 * full live deployment.
 *
 * ### Creating Next.js Sites
 * **Example:** Basic Next.js App
 * ```typescript
 * const site = yield* Railway.Website.Nextjs("Web", {
 *   rootDir: "./app",
 * });
 * ```
 *
 * ### Server Configuration
 * **Example:** Process Environment
 * ```typescript
 * const site = yield* Railway.Website.Nextjs("Web", {
 *   rootDir: "./app",
 *   env: {
 *     API_BASE: "https://api.example.com",
 *   },
 * });
 * ```
 *
 * @resource
 * @product Website
 */
export const Nextjs = (id: string, props: NextjsProps = {}) =>
  makeFrameworkSite(id, props, {
    name: "Nextjs",
    framework: NEXTJS_FRAMEWORK_SPECIFIER,
    target: NEXTJS_NODE_TARGET_SPECIFIER,
    bake: "next",
    install: ["next", "react", "react-dom"],
  }).pipe(Namespace.push(id));