Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyborq/electron-desktop-startup
https://github.com/kyborq/electron-desktop-startup
Last synced: 15 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kyborq/electron-desktop-startup
- Owner: kyborq
- Created: 2024-11-08T12:32:27.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T12:42:56.000Z (3 months ago)
- Last Synced: 2024-11-08T13:41:25.442Z (3 months ago)
- Language: TypeScript
- Size: 141 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Electron Desktop Startup
Template for Electron with React and Typescript based on Vite.
## What's inside?
This boilerplate includes the following features and technologies:
### Frontend
- **Zustand**: A state management library for React, with support for broadcasting and persistence.
- **React Router Dom**: A routing library for React, using the hash router.
- **React Query and Axios**: For handling network requests and data fetching.
- **CSS Modules**: For modular and scoped CSS styles.
- **Helpers for classNames**: Utility functions for working with CSS class names.
### Backend
- **Streamlined Boilerplate**: The boilerplate code has been removed, leaving a more focused and minimal setup.
- **Window Manager**: An implementation of a window manager for your Electron application.
## Getting Started
To get started with this project, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/your-username/electron-desktop-startup.git
```
2. Install dependencies:
```bash
cd electron-desktop-startup
npm install
```
3. Start the development server:
```bash
npm run dev
```
This will start the Electron application in development mode, with hot reloading enabled for the frontend.
## Building for Production
To build the application for production, run:
```bash
npm run build
```
This will create a production-ready package for your Electron application.
## Customization
You can customize this boilerplate to fit your specific needs. Feel free to modify the frontend and backend components, add new features, and integrate additional libraries as required.
## Contributing
If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.