A modern boilerplate to build cross-platform, high-performance desktop applications using Electron, React, Tailwind CSS, and other cutting-edge web development tools.

• ElectronJS: Cross-platform desktop app development with web technologies.
• ReactJS: Efficient library for building dynamic user interfaces.
• TailwindCSS: Utility-first CSS framework for fast UI development.
• ShadcnUI: Reusable and customizable components to speed up development.
• Vite: Lightning-fast development server with hot module replacement (HMR).
• Vitest: Fast and simple unit testing for React components.
• React Testing Library: Helps test React components in a user-centric way.
• Happy DOM: A fast DOM simulation for testing React components.
• BiomeJS: A fast and reliable linter and code formatter for consistent code style.

1. Clone or Fork the Repository

You can either use this template by clicking the "Use this template" button or clone the repository to your local machine:

git clone https://github.com/Molizanee/electron-react-tailwind.git && cd electron-react-tailwind

2. Install Dependencies

Once inside the project directory, install all required dependencies:

bun i

3. Run the Development Server

Start the project in development mode with hot-reloading enabled:

bun dev

4. Run Tests

Run all tests with Vitest:

bun run test

To open the Vitest UI for a visual overview of your tests:

bun run test:ui

5. Build the Web Application

To build the web version for production:

bun run build:web

6. Build the Desktop Application

To build the desktop application for distribution:

bun run build:desktop

7. Start the Web Application

To preview the built web application:

bun run start:web

8. Start the Desktop Application

To run the built desktop application:

bun run start:desktop

9. Lint the Code

To check and fix code style issues:

bun run lint

10. Run Tests with Coverage

To run tests and generate coverage reports:

bun run coverage

This project is licensed under the MIT License.

Feel free to contribute! Please submit a pull request or open an issue for any changes or improvements.