Files
sveltekit-adapters/README.md
Luke Hagar 197a2e3f1d Enhance README.md for adapter-electron with detailed features and integration notes
- Updated the description to highlight native protocol handling and Vite integration.
- Added key features of the adapter, including development integration and production readiness.
- Clarified example app usage and provided detailed setup instructions for better user guidance.
2025-07-23 16:48:35 -05:00

2.5 KiB

SvelteKit Adapters

This repo contains the below adapters and example implementations for each adapter.

Appwrite adapter

Adapter | Example

Deploy SvelteKit applications as appwrite functions.

I have tested and validated the implementation with the node20 runtime. Other runtimes may work but have not been tested.

Electron adapter

Adapter | Example

Deploy SvelteKit applications as Electron desktop applications with native protocol handling.

This adapter provides seamless integration between SvelteKit and Electron, featuring:

  • Native Protocol Handling: Uses Electron's protocol.handle() API for production
  • Development Integration: Seamless Vite dev server integration with hot module replacement
  • Full SvelteKit Support: SSR, API routes, static assets, prerendered pages, and form actions
  • Clean Architecture: All Electron integration code is encapsulated
  • Production Ready: Works with electron-builder and similar packaging tools

The adapter automatically handles the build process and provides helper functions for setting up the Electron main process. Please look at the example implementation for detailed setup instructions.

What's inside?

This repo includes the following packages and examples:

Examples

  • appwrite: a SvelteKit example app that uses the adapter-appwrite adapter [Link]
  • electron: a SvelteKit example app that uses the adapter-electron adapter with native protocol handling [Link]

Packages

  • adapter-appwrite: a SvelteKit adapter for deploying applications as appwrite functions [Link]
  • adapter-electron: a SvelteKit adapter for deploying applications as Electron desktop applications with native protocol handling and Vite integration [Link]