Skip to content

SolidStart

Railway.Website.SolidStart deploys a SolidStart app to Railway. It runs your project’s own vite build and appends nitro’s node preset: the SSR server plus client assets (prerendered pages included) run on one Railway.Service. Alchemy creates a Railway.Project if you omit project. The URL is the generated *.up.railway.app hostname. No adapter.

Install

Section titled “Install”

The build integration is not bundled with alchemy. Install @alchemy.run/frontend-frameworks; the resource loads its /solidstart and /solidstart/node exports from your project at deploy time. It is only used at build time, so a dev dependency is enough:

Terminal window
bun add -d @alchemy.run/frontend-frameworks

@solidjs/vite-plugin-nitro-2 is the server half of a SolidStart build and must be a project dependency too:

Terminal window
bun add @solidjs/vite-plugin-nitro-2

Configure Vite

Section titled “Configure Vite”

Your vite.config.ts is the SolidStart plugin — no adapter, no nitro wiring. Vite plugins like Tailwind go in plugins as usual:

vite.config.ts
import { solidStart } from "@solidjs/start/config";
import tailwindcss from "@tailwindcss/vite";
import { defineConfig } from "vite";


export default defineConfig({
  plugins: [solidStart(), tailwindcss()],
});

Alchemy appends its own nitroV2Plugin() instance at build time, carrying nitro’s node preset. Don’t register nitroV2Plugin() yourself — the appended instance would discard its options, so the build fails with an actionable error instead. Pass nitro options through the resource’s nitro prop; see Prerendering below.

Declare the Website

Section titled “Declare the Website”

Declare the site as a module-level const (rather than inline in the Stack):

alchemy.run.ts
import * as Railway from "alchemy/Railway";


export const Website = Railway.Website.SolidStart("Website");

Pass project to put the Service in an existing Railway.Project. rootDir is the project root — the directory holding package.json and vite.config.*. It defaults to ".", so set it only when the app does not sit next to alchemy.run.ts:

export const Website = Railway.Website.SolidStart("Website", {
  rootDir: "./app",
});

Add it to the Stack

Section titled “Add it to the Stack”

Yield the site from your Stack and return its URL:

alchemy.run.ts
import * as Alchemy from "alchemy";
import * as Effect from "effect/Effect";


export default Alchemy.Stack(
  "MySolidStartSite",
  {
    providers: Railway.providers(),
    state: Alchemy.localState(),
  },
  Effect.gen(function* () {
    const site = yield* Website;
    return { url: site.url };
  }),
);

The live url is https://{name}.up.railway.app. site.service and site.project are the Railway resources underneath — undefined during alchemy dev.

See the SolidStart API reference for every prop and attribute.

Add environment variables

Section titled “Add environment variables”

Process environment is a top-level env map — plain strings, or Redacted values:

alchemy.run.ts
export const Website = Railway.Website.SolidStart("Website", {
  env: {
    API_BASE: "https://api.example.com",
  },
});

The values are copied onto process.env before the build and the dev server, and onto the Service at deploy time, so server code reads the same keys in both modes. Client inlining is whatever Vite does (VITE_ prefixes).

An output from another resource only exists once that resource is yielded, so declare the site inside the Stack generator instead:

alchemy.run.ts
Effect.gen(function* () {
  const api = yield* Api;


  const site = yield* Railway.Website.SolidStart("Website", {
    env: { API_BASE: api.url },
  });


  return { url: site.url };
});

Read the environment in server code

Section titled “Read the environment in server code”

The SolidStart server is a plain Node process, so API routes, server functions, and SSR read the environment from process.env:

src/routes/api/hello.ts
export function GET() {
  return new Response(process.env.API_BASE ?? "unset");
}

Values prefixed VITE_ are inlined into the client bundle at build time instead, as import.meta.env.VITE_* — set those in the shell that runs alchemy deploy, not in env.

Prerendering

Section titled “Prerendering”

Nitro renders the routes you list at build time into .output/public. They are baked into the Service image and served as static files with no handler invocation:

export const Website = Railway.Website.SolidStart("Website", {
  nitro: { prerender: { routes: ["/", "/about"] } },
});

prerender takes the routes to render (routes) and can crawl links from prerendered pages to prerender them too (crawlLinks). The nitro prop is the home for all nitro options (route rules, storage, …) — the integration owns the plugin instance, so they cannot live in vite.config.ts. Values must be JSON-serializable; preset is owned by the Node deploy target, and a foreign preset is a hard error.

Local dev

Section titled “Local dev”
Terminal window
bun alchemy dev

alchemy dev runs SolidStart’s own Vite dev server (native HMR) instead of deploying; site.url is the local address and no Railway resources are created. Nitro plays no part in dev. Wrap the site in Alchemy.remote() to deploy the live Service even during dev:

export const Website = Railway.Website.SolidStart("Website").pipe(
  Alchemy.remote(),
);

SolidStart’s plugin resolves its app root and route directory from the process working directory, so one alchemy dev process serves one SolidStart app at a time.

Custom domain

Section titled “Custom domain”
const site = yield* Railway.Website.SolidStart("Web", {
  domain: "app.example.com",
});

domain attaches a Railway.CustomDomain (targetPort 3000). url becomes https://app.example.com instead of the generated *.up.railway.app.

Where next

Section titled “Where next”