Electron Boilerplate
Boilerplate for Electron apps with file-based router, tailwind, shadcn/ui, and many more.
Overview
The Electron Boilerplate is a powerful starting point for building desktop applications using modern web technologies. It brings together a well-structured environment that includes everything you need right out of the box, making it ideal for developers looking for an efficient way to kick off their projects. With components like Electron Forge, Vite, and TailwindCSS, this boilerplate streamlines the development process while ensuring a high degree of customization.
Whether you prefer using the system default title-bar or a custom implementation, this boilerplate is versatile enough to meet various design needs. Its solid architecture supports TypeScript, provides a file-based routing system through Tanstack, and is designed for ease of use, making it an excellent choice for both newcomers and experienced developers in the desktop application landscape.
Features
- Electron Forge: Seamlessly package your application for various platforms without additional configuration or complexity.
- Vite: Experience a fast and efficient development environment with instant server start and hot module replacement.
- React: Build your user interface with React, benefiting from its component-based architecture and robust ecosystem.
- TailwindCSS: Utilize a utility-first CSS framework for creating custom designs quickly and easily, without leaving your HTML.
- Full TypeScript support: Write type-safe JavaScript code with full support for TypeScript, ensuring better development productivity and fewer runtime errors.
- Tanstack file-based router: Effortlessly manage routing by simply adding new routes to the app directory, automatically updating your project.
- Custom title-bar option: Choose between the default system title-bar and a customizable one, allowing for better UI/UX tailored to your application needs.
- Documentation and Support: Comprehensive documentation guides you through setup, usage, and routing conventions to help you get started quickly.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- TanStack
TanStack is a collection of high-quality, framework-agnostic libraries including TanStack Query for data fetching, TanStack Router for routing, TanStack Table for tables, and more. These tools provide powerful, type-safe solutions for common web development challenges.
- Vite
Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- Shadcn UI
Beautifully designed components that you can copy and paste into your apps. Accessible. Customizable. Open Source.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Postcss
PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.