Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/molizanee/electron-react-tailwind
Boilerplate to build ElectronJS with ReactJS and modern web tools!
https://github.com/molizanee/electron-react-tailwind
biomejs electronjs react-testing-library reactjs shadcn-ui tailwindcss vite vitest
Last synced: about 1 month ago
JSON representation
Boilerplate to build ElectronJS with ReactJS and modern web tools!
- Host: GitHub
- URL: https://github.com/molizanee/electron-react-tailwind
- Owner: Molizanee
- Created: 2024-09-16T12:59:10.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T18:55:31.000Z (2 months ago)
- Last Synced: 2024-10-15T17:03:14.681Z (about 1 month ago)
- Topics: biomejs, electronjs, react-testing-library, reactjs, shadcn-ui, tailwindcss, vite, vitest
- Language: HTML
- Homepage:
- Size: 127 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Electron + React + Tailwind Boilerplate
A modern boilerplate to build cross-platform, high-performance desktop applications using Electron, React, Tailwind CSS, and other cutting-edge web development tools.
## Features
- **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.
## Getting Started
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:
```bash
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:
```bash
npm install
```
3. Run the Development Server
Start the project in development mode with hot-reloading enabled:
```bash
npm run dev
```
4. Run Tests
Run all tests with Vitest:
```bash
npm run test
```
To open the Vitest UI for a visual overview of your tests:
```bash
npm run test:ui
```
5. Build the Project
To build the project for production:
```bash
npm run build
```
This will bundle your application and prepare it for distribution across different platforms.
## License
This project is licensed under the MIT License - see the LICENSE file for details.
## Contributions
Feel free to contribute! Please submit a pull request or open an issue for any changes or improvements.