Svelte-adapter-deno-deploy NPM

svelte-adapter-deno-deploy

Adapter for SvelteKit apps that generates server for Deno Deploy.

Usage

Install with npm i -D svelte-adapter-deno-deploy, then add the adapter to your svelte.config.js:

// svelte.config.js
import adapter from 'svelte-adapter-deno-deploy';

export default {
  kit: {
    adapter: adapter()
  }
};

After building the server (npm run build), use the following command to start:

# with the default build directory
deno run --allow-env --allow-read --allow-net build/server.js

# with a custom build directory
deno run --allow-env --allow-read --allow-net path/to/build/server.js

You can use this github action to automatically deploy your app in deno deploy

.github/workflows/deploy.yml

name: Deploy

on: [push]

jobs:
  deploy: 
    name: deploy
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read 
      
    steps:
      - name: Clone repository
        uses: actions/checkout@v2

      - uses: actions/setup-node@v2
        with:
          node-version: 16
      - name: Running npm install
        run: npm install

      - name: Build site
        run: npm run build

      - name: Remove node_modules
        run: rm -rf node_modules

      - name: Deploy to Deno Deploy
        uses: denoland/deployctl@v1
        with:
          project: <YOUR PROJECT NAME>
          entrypoint: "{out}/server.js" # same as `out` option in config
          root: "{out}"

The server needs at least the following permissions to run:

-- allow-env - allow environment access, to support runtime configuration via runtime variables (can be further restricted to include just the necessary variables)

allow-read - allow file system read access (can be further restricted to include just the necessary directories)
allow-net - allow network access (can be further restricted to include just the necessary domains)

Additionally, --no-check can be used if deno complains while typechecking upstream dependencies.

Options

out

The directory to build the server to. It defaults to build — i.e. deno run --allow-read --allow-net build/server.js would start the server locally after it has been created.

serverFile

You can provide your own server file and use build/handler.js to handle sveltekit requests. if this option not provided, build/server.js will be created

precompress

Enables precompressing using gzip and brotli for assets and prerendered pages. It defaults to false.

deps

The file re-exporting external runtime dependencies (deps.ts by convention in Deno). It defaults to the deps.ts included in the package.

Environment variables

By default, the server will accept connections on 0.0.0.0 using port 3000. These can be customised with the PORT and HOST environment variables:

HOST=127.0.0.1 PORT=4000 deno run --allow-env --allow-read --allow-net build/server.js

You can specify different environment variables if necessary using the env option.

Advanced Configuration

esbuild

As an escape hatch, you may optionally specify a function which will receive the final esbuild options generated by this adapter and returns a modified esbuild configuration. The result of this function will be passed as-is to esbuild. The function can be async.

For example, you may wish to add a plugin:

adapterDeno({
  esbuild(defaultOptions) {
    return {
      ...defaultOptions,
      plugins: []
    };
  }
});

The default options for this version are as follows:

{
  entryPoints: ['.svelte-kit/deno/handler.js'],
  outfile: 'build/handler.js',
  bundle: true,
  serverFile: undefined,
  filesPrefix: './',
  format: 'esm',
  platform: 'neutral',
  sourcemap: 'external'
}