# uilX

**Repository Path**: MacRsh/uilX

## Basic Information

- **Project Name**: uilX
- **Description**: 可扩展的快速发布UI框架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-16
- **Last Updated**: 2026-07-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# uilx

An extensible cross-platform application base built with Tauri 2, React,
TypeScript, and Rust.

The base currently includes:

- Dependency-ordered frontend and native module hosts
- Automatic frontend discovery and an explicit native module catalog
- Typed services, contributed routes, and contributed settings sections
- Namespaced JSON storage shared by desktop and browser development
- Persistent in-app notification history and transient toast feedback
- Simplified Chinese and English localization
- Persistent language and close-button settings
- About and build diagnostics
- Signed desktop update service with release-safe configuration
- Custom desktop window chrome
- Hide-to-tray and exit behavior on desktop

## Project Layout

```text
branding/             product icon source
docs/                 architecture and release guides
schemas/              product configuration schema
scripts/              product preparation and release tools
src/                  React application and frontend modules
src-tauri/            Rust runtime and desktop capabilities
product.config.json   replaceable product identity and release settings
```

## Development

Install dependencies and start the desktop application:

```shell
npm install
npm run desktop:dev
```

Run all current checks:

```shell
npm run release:check
```

Use the optimized release executable under `src-tauri/target/release` when
evaluating window-resize smoothness. Development and debug builds prioritize
diagnostics and fast compilation, so their native resize path is not a reliable
performance baseline.

The web UI can also run without Tauri for fast visual work. Browser development
uses local storage and omits native window operations:

```shell
npm run dev
```

## Architecture

The application uses two small module hosts:

- `src/kernel` manages UI modules, typed services, routes, settings sections,
  startup rollback, and reverse-order disposal.
- `src-tauri/src/kernel.rs` manages native modules with the same dependency and
  lifecycle rules.

Frontend modules are automatically discovered from `src/modules/**/module.ts`
through Vite. Native modules are listed in the small `native_modules` catalog in
`src-tauri/src/lib.rs`, where the Rust compiler can keep the IPC and native trust
boundary explicit.

Start with the Chinese [`docs/tutorial.md`](docs/tutorial.md), which walks
through modules, notifications, storage, UI development, and publishing. More
detailed references are available in [`docs/architecture.md`](docs/architecture.md),
[`docs/storage-and-notifications.md`](docs/storage-and-notifications.md),
[`docs/ui-development.md`](docs/ui-development.md),
[`docs/product-customization.md`](docs/product-customization.md), and
[`docs/updates.md`](docs/updates.md).