README.md

svelte-adapter-appengine

Easily deploy your SvelteKit applications on Google Cloud App Engine with the svelte-adapter-appengine package.

Getting Started

To set up the adapter in your SvelteKit project:

1. Install the package as a development dependency:

npm install --save-dev svelte-adapter-appengine

2. Update your svelte.config.js to use the adapter:

import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
+import adapter from "svelte-adapter-appengine";

/** @type {import('@sveltejs/kit').Config} */
const config = {
  preprocess: vitePreprocess(),

  kit: {
+   adapter: adapter(),
  },
};

export default config;

3. Build your application:

npm run build

4. Deploy your application to App Engine:

gcloud app deploy --project <CLOUD_PROJECT_ID> build/app.yaml

Learn more about the gcloud utility in the official documentation

Configuration Options

Customize the adapter behavior using the following options:

adapter({
  // Build output directory (default: `/build`)
  out: "/build",

  // Enable Google Cloud Tracing Agent for improved logging (default: `false`)
  useCloudTracing: false,

  // Enable or disable Google Cloud Logging (default: `false`)
  // See: https://cloud.google.com/logging/docs/overview
  useCloudLogging: false,

  // Specify external modules for the esbuild step
  external: [],

  // Specify Node modules to be added to the `package.json` file in the build step
  // These modules will be fetched when the application is deployed
  dependencies: [],

  // Set the Node.js version for the App Engine runtime (default: `18`)
  // See available runtimes: https://cloud.google.com/appengine/docs/standard/nodejs/runtime
  nodejsRuntime: 18,
});

You can also customize the generated app.yaml file by creating an app.yaml file in your project root. The adapter will merge your custom configuration with the generated app.yaml, allowing you to define custom machine types, routes, or other app.yaml configurations.

Adapter Output

The Server-Side Rendering (SSR) part of SvelteKit is hosted on App Engine using a Node.js runtime, using polka to mimic @sveltejs/adapter-node .

Static files are served directly from Cloud Storage, bypassing the Node.js web server. The adapter automatically generates routes for all static assets in the app.yaml file.

Example Application

Check out a live example application at https://svelte-adapter-demo.uc.r.appspot.com/. This demo app is the default SvelteKit template deployed with the default adapter settings.