Skip to content

Foldkit

GCP.Website.Foldkit deploys a Foldkit app to Cloud Run. It is Vite with single-page routing turned on, so a deep link loads index.html and boots the app.

Install

Section titled “Install”

The build integration ships separately. It only runs at deploy time, so a dev dependency is enough:

Terminal window
pnpm add -D @alchemy.run/frontend-frameworks@latest

Docker has to be running when you deploy. The image is built on your machine.

Deploy the site

Section titled “Deploy the site”
alchemy.run.ts
import * as Alchemy from "alchemy";
import * as GCP from "@alchemy.run/gcp";
import * as Effect from "effect/Effect";


export const Website = GCP.Website.Foldkit("Website");


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

Run alchemy deploy. site.url is the Cloud Run service URL.

Project in a subdirectory

Section titled “Project in a subdirectory”
export const Website = GCP.Website.Foldkit("Website", {
  rootDir: "applications/web",
});

Serve a real 404 page

Section titled “Serve a real 404 page”
export const Website = GCP.Website.Foldkit("Website", {
  assets: { notFoundHandling: "404-page" },
});

Tune Cloud Run

Section titled “Tune Cloud Run”
export const Website = GCP.Website.Foldkit("Website", {
  scaling: { minInstanceCount: 1 },
  resources: { limits: { cpu: "1", memory: "1Gi" } },
});

One warm instance means no cold start for the first visitor. See Websites for the other settings.

Local development

Section titled “Local development”

alchemy dev runs the framework’s dev server with hot reload and creates nothing in the cloud. Wrap the site in Alchemy.remote() to deploy it for real during dev.

Where next

Section titled “Where next”