https://github.com/bdani0717/sveltekit-electron-starter
A no bloat starter template combining SvelteKit and Electron.
https://github.com/bdani0717/sveltekit-electron-starter
boilerplate electron eslint prettier sveltekit tailwindcss typescript
Last synced: 5 months ago
JSON representation
A no bloat starter template combining SvelteKit and Electron.
- Host: GitHub
- URL: https://github.com/bdani0717/sveltekit-electron-starter
- Owner: bdani0717
- License: mit
- Created: 2025-03-09T07:35:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-22T10:44:18.000Z (over 1 year ago)
- Last Synced: 2025-09-25T18:15:48.327Z (9 months ago)
- Topics: boilerplate, electron, eslint, prettier, sveltekit, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 134 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SvelteKit + Electron Starter
A modern desktop application starter template combining SvelteKit and Electron.
## Features
- [Electron](https://www.electronjs.org/)
- [Electron vite](https://electron-vite.org/)
- [SvelteKit](https://svelte.dev/docs/kit/introduction)
- [TailwindCSS v4](https://tailwindcss.com/)
### Testing and code quality
- [Vitest](https://vitest.dev/)
- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
## Quick Start
```bash
# Install dependencies
npm install
# Start development server
npm run dev
```
### Building
```bash
# For macos
npm run build:mac
# For windows
npm run build:win
# For linux
npm run build:linux
```
### Testing
```bash
# Run vitest tests
npm run test
```
### File protocol
For loading files use the custom `fs://` protocol. The default electron files protocol doesn't work with sveltekit.
```html
![]()
```
## Project Structure
```shell
project
├── resources # Application resources
├── src #
│ ├── main # Main scripts
│ ├── preload # Preload scripts
│ ├── renderer # SvelteKit (renderer) folder
│ │ ├── lib # Lib folder for SvelteKit
│ │ └── routes # Routes
│ └── shared # Shared files between main, preload and renderer
├── static # Static assets for SvelteKit
├── electron.vite.config.ts
├── eslint.config.mjs
├── package.json
├── svelte.config.js
├── tsconfig.json
├── vite.config.ts
└── vitest-setup-client.ts
```