Svelte Themes Logo Svelte Themes
Svelte Electron Boilerplate screenshot

Svelte Electron Boilerplate

Author Avatar Theme by Ptkdev boilerplate
Updated: 1 Feb 2022
129 Stars

Create a desktop app with this user-friendly Svelte boilerplate for electron

Github Live Preview

Categories

Bulma Scss

Overview:

Svelte-electron-boilerplate is a user-friendly Svelte boilerplate for building desktop applications with Electron. It is a free and open-source project that aims to provide an excellent development environment with a preconfigured setup for Svelte, Electron, and TypeScript. The project offers features such as easy setup, MIT license, Svelte SPA integration with Electron, browser sync, dark mode, optimized for Google Speedpage, and more. It also provides extensive documentation and support for developers.

Features:

  • Easy to use: The boilerplate provides a user-friendly setup with preconfigured configurations and templates.
  • MIT License: The project is licensed under the MIT license, allowing users to use, modify, and distribute the code.
  • Svelte SPA + Electron Desktop App: The boilerplate combines the Svelte framework with Electron to build desktop applications.
  • Browser sync, auto refresh, auto reload: The project includes browser sync functionality for automatic refreshing and reloading of the application during development.
  • Dark mode: The boilerplate supports a dark mode theme for the desktop application.
  • 100% on Google Speedpage: The project is optimized for performance and aims to achieve a 100% score on Google Speedpage.
  • Friendly boilerplate + Github templates: The boilerplate provides a user-friendly structure and includes templates for easy project setup.
  • Powered by Svelte framework: The project utilizes the Svelte framework for building reactive user interfaces.
  • Without jQuery dependence: The boilerplate does not depend on jQuery, reducing unnecessary dependencies.
  • Typescript + TSPaths preconfigured: The project is preconfigured to support TypeScript and includes TSPaths for easier module resolution.
  • User-friendly folders tree: The project has a well-organized and easy-to-navigate folder structure.
  • Prettiers and ESLint preconfigured: The boilerplate comes with preconfigured Prettier and ESLint settings for code formatting and linting.
  • All-contributors-cli and all-shields-cli preconfigured: The project includes preconfigured tools for managing contributors and generating shields/badges.
  • JEST Test preconfigured: The boilerplate is preconfigured for JEST testing, making it easier to write unit tests.
  • Full async code: The project supports full asynchronous coding for enhanced performance.
  • Github and Vscode dotfiles preconfigured: The boilerplate includes preconfigured dotfiles for Github and Vscode for smoother project management and development.
  • Translations i18n: The project supports internationalization (i18n) for easy translation of the application.

Installation:

To install and use the svelte-electron-boilerplate, follow these steps:

  1. Clone this repository or download the desired version (nightly, beta, or stable).
  2. Run npm install to install the project dependencies.
  3. Run npm run dev to start the development server for the Svelte app.
  4. Run npm run dev:electron to start the Electron app and run it alongside the Svelte app.

Summary:

The svelte-electron-boilerplate is a user-friendly and feature-rich boilerplate for building desktop applications with Svelte and Electron. It provides easy setup, preconfigured configurations and templates, and various features such as browser sync, dark mode, performance optimization, TypeScript support, and more. The boilerplate also ensures support for internationalization and offers extensive documentation and support for developers.