Skip to content

Railway

Railway is a cloud for running containers and the databases beside them. A project groups your services, Postgres, MySQL and Redis databases, volumes and buckets. Railway runs each service, gives it a URL, and connects everything in the project over a private network. Environments copy a whole project for staging or a pull request, and you pay only for the CPU and memory you use.

New to Railway? Start with What is Railway?.

A quick example

Section titled “A quick example”

A project is a declaration:

src/project.ts
import * as Railway from "@alchemy.run/railway";


export const Site = Railway.Project("Site");

A Service is your program in it:

src/api.ts
import * as Railway from "@alchemy.run/railway";
import * as Effect from "effect/Effect";
import * as HttpServerResponse from "effect/http/HttpServerResponse";
import { Site } from "./project.ts";


export default class Api extends Railway.Service<Api>()(
  "Api",
  { project: Site, main: import.meta.url, port: 3000 },
  Effect.gen(function* () {
    return {
      fetch: Effect.succeed(HttpServerResponse.text("hello from Railway")),
    };
  }),
) {}

And the Stack deploys it to your workspace, with a public *.up.railway.app URL:

alchemy.run.ts
import * as Alchemy from "alchemy";
import * as Railway from "@alchemy.run/railway";
import * as Effect from "effect/Effect";
import Api from "./src/api.ts";


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

Where to start

Section titled “Where to start”

Want to build? The tutorial goes from an empty directory to a project running an HTTP Service with a Volume and a variable, one step at a time. Start with Setup to connect your workspace.

Looking for something specific? Every section of these docs is listed below, and every resource is in the generated API reference.

The docs

Section titled “The docs”

Accounts & access

Compute

Data

Networking

Frontend