# win-island

**Repository Path**: honghao5478/win-island

## Basic Information

- **Project Name**: win-island
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-08
- **Last Updated**: 2026-06-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Electron, tauri, TypeScript, Rust, Vue

## README



# win-island

An Electron application built with Vue and TypeScript, using electron-vite as the build tool.

## Overview

win-island is a desktop application that demonstrates a modern Electron + Vue 3 + TypeScript setup. The project uses electron-vite for optimized building and bundling, and features a multi-window architecture with a main window and an "island" window.

## Features

- **Electron** - Cross-platform desktop application framework
- **Vue 3** - Progressive JavaScript framework for building user interfaces
- **TypeScript** - Typed superset of JavaScript
- **electron-vite** - Next-generation Electron build tooling
- **Multi-window Support** - Main window and island window architecture

## Project Structure

```
win-island/
├── src/
│   ├── main/           # Main process (Electron main)
│   │   └── index.ts    # Application entry point, window management
│   ├── preload/        # Preload scripts
│   │   ├── index.ts    # Context bridge API
│   │   └── index.d.ts  # TypeScript declarations
│   └── renderer/       # Renderer process (Vue application)
│       ├── index.html  # Main window HTML
│       ├── island.html # Island window HTML
│       └── src/
│           ├── App.vue           # Main window root component
│           ├── main.ts           # Main window entry
│           ├── island/           # Island window
│           │   ├── App.vue
│           │   └── main.ts
│           └── components/      # Vue components
│               └── Versions.vue
├── build/              # Build resources (icons, entitlements)
├── resources/          # Application resources
└── electron.vite.config.ts  # Vite configuration for Electron
```

## Recommended IDE Setup

- [VSCode](https://code.visualstudio.com/) - Code editor
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) - JavaScript/TypeScript linting
- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) - Code formatting
- [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) - Vue.js tooling for VSCode

## Getting Started

### Prerequisites

- Node.js (LTS version recommended)
- yarn (or npm/pnpm)
- For macOS development: Xcode
- For Linux development: Build tools (gcc, make, etc.)

### Installation

Install dependencies using yarn:

```bash
yarn
```

### Development

Start the development server with hot reload:

```bash
yarn dev
```

This command will launch the application in development mode with hot module replacement enabled.

### Build

Build the application for your target platform:

```bash
# For Windows
yarn build:win

# For macOS
yarn build:mac

# For Linux
yarn build:linux
```

Built executables will be generated in the `dist` folder.

## Technology Stack

- **Framework**: Electron
- **Frontend**: Vue 3 + TypeScript
- **Build Tool**: electron-vite
- **Package Manager**: yarn

## License

See the [LICENSE](./LICENSE) file for details.


Stand on the shoulders of giants