# LytX

**Repository Path**: lytjs/lytx

## Basic Information

- **Project Name**: LytX
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-17
- **Last Updated**: 2026-05-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# LytX

基于 LytJS v6.6.0 的现代化 JavaScript 元框架，提供完整的全栈开发体验。

## 功能特性

- ✨ **文件系统路由** - 基于文件系统的约定式路由，直观易用
- 🔧 **API 路由** - 内置 API 路由系统，快速构建后端服务
- 🌐 **SSR/SSG/ISR** - 服务端渲染、静态生成和增量静态再生成
- 📦 **完整的状态管理** - 内置 Zustand 风格的状态管理 (@lytjs/store)
- 🎨 **40+ UI 组件** - 开箱即用的 UI 组件库，提升开发效率
- 🔌 **13个官方插件** - 表单、国际化、数据获取、主题、认证等
- 🔧 **30+通用工具函数** - 从 LytJS Common 生态引入的工具包
- 📋 **开发调试工具** - 内置 DevTools，提升开发体验
- 🚀 **生产就绪** - 一键部署到 Vercel、Netlify、Cloudflare Pages
- 🎯 **类型安全** - 完全 TypeScript 支持
- 🔥 **热模块替换** - 快速的开发体验
- 📱 **Edge 运行时** - 支持边缘计算

## 安装

### 方式一：使用 create-lytx-app (推荐)

```bash
npx create-lytx-app my-app
# 或者使用 pnpm
pnpm create lytx-app my-app
# 或者使用 yarn
yarn create lytx-app my-app

cd my-app
npm install
npm run dev
```

### 方式二：手动安装

```bash
npm install @lytjs/lytx
# 或
pnpm add @lytjs/lytx
# 或
yarn add @lytjs/lytx
```

## 快速开始

### 使用 CLI 创建项目

```bash
npx create-lytx-app my-app --template todo
# 或使用博客模板
npx create-lytx-app my-blog --template blog
# 或使用完整功能模板
npx create-lytx-app my-full-app --template full
```

可用模板：

| 模板 | 描述 |
|------|------|
| `default` | 默认模板，包含所有核心功能 |
| `minimal` | 最小化模板，仅基础功能 |
| `todo` | 待办事项示例，包含状态管理和 UI 组件 |
| `blog` | 博客系统，包含 SSR/SSG 和 API 路由 |
| `full` | 完整功能模板，包含所有功能 |

### 快速查看示例项目

查看我们的示例应用：

```bash
cd examples/todo-app
cd examples/blog-app
```

## 项目结构

### 完整的 LytX 应用

```
my-lytx-app/
├── src/
│   ├── pages/         # 页面文件 (file-system routing)
│   │   ├── index.ts   # 首页
│   │   └── about.ts   # 关于页
│   ├── api/           # API 路由
│   │   └── hello.ts   # API 示例
│   ├── stores/        # 状态管理
│   │   └── todo.ts
│   ├── data/          # 数据
│   │   └── posts.ts
│   ├── styles/        # 样式文件
│   │   ├── todo.css
│   │   └── blog.css
│   └── layouts/       # 布局组件
│       └── root.ts
├── lytx.config.ts     # LytX 配置
├── tsconfig.json      # TypeScript 配置
└── package.json
```

### LytX 包结构

LytX 采用模块化设计，你可以使用整个包，也可以按需使用单个功能包：

| 包名 | 描述 |
|------|------|
| `@lytjs/lytx` | 主包，包含所有功能的便捷入口 |
| `@lytjs/lytx-core` | 核心运行时 + 全部 13 个官方插件 |
| `@lytjs/lytx-router` | 文件系统路由系统 |
| `@lytjs/lytx-api` | API 路由 + 中间件系统 |
| `@lytjs/lytx-ssr` | SSR/SSG/ISR 渲染 + 元数据 |
| `@lytjs/lytx-store` | 状态管理 (基于 @lytjs/store) |
| `@lytjs/lytx-ui` | UI 组件库 (40+ 组件) |
| `@lytjs/lytx-devtools` | 开发调试工具 |
| `@lytjs/lytx-common` | 30+ 通用工具函数 |
| `@lytjs/lytx-deploy` | 部署适配器 (Vercel/Netlify/Cloudflare) |
| `@lytjs/lytx-cli` | 命令行工具 |
| `create-lytx-app` | 项目脚手架 |

### 使用单个包

你可以只使用需要的功能，例如：

```typescript
// 仅使用 UI 组件
import { Button, Card } from '@lytjs/lytx-ui';
// 仅使用状态管理
import { defineStore } from '@lytjs/lytx-store';
// 仅使用通用工具
import { isArray, debounce } from '@lytjs/lytx-common';
```

## LytJS 生态整合

LytX 建立在完整的 LytJS v6.6.0 生态之上：

### 官方插件 (13个)

| 插件 | 功能 |
|------|------|
| `@lytjs/plugin-validation` | 数据验证 |
| `@lytjs/plugin-data` | 数据获取和缓存 |
| `@lytjs/plugin-form` | 表单管理 |
| `@lytjs/plugin-i18n` | 国际化 (i18n) |
| `@lytjs/plugin-data-fetch` | 数据获取 (带缓存/重试/拦截器) |
| `@lytjs/plugin-storage` | 本地存储管理 |
| `@lytjs/plugin-theme` | 主题切换 |
| `@lytjs/plugin-auth` | 认证系统 |
| `@lytjs/plugin-logger` | 日志系统 |
| `@lytjs/plugin-chart` | 图表支持 |
| `@lytjs/plugin-animation` | 动画支持 |
| `@lytjs/plugin-vite` | Vite 集成 |
| `@lytjs/plugin-testing` | 测试工具 |

### 通用工具 (30+ 个包)

- `@lytjs/common-is` - 类型判断
- `@lytjs/common-object` - 对象工具
- `@lytjs/common-http` - HTTP 工具
- `@lytjs/common-error` - 错误处理
- `@lytjs/common-events` - 事件系统
- `@lytjs/common-cache` - 缓存工具
- `@lytjs/common-storage` - 存储工具
- `@lytjs/common-string` - 字符串工具
- `@lytjs/common-dom` - DOM 工具
- 还有 20+ 更多！

## 文档

查看完整文档：https://gitee.com/lytjs/lytx/tree/main/docs

## 开发

### 本地开发 LytX

```bash
# 克隆项目
git clone https://gitee.com/lytjs/lytx.git
cd lytx

# 安装依赖
pnpm install

# 构建所有包
pnpm run build

# 运行测试
pnpm run test
```

### 开发工作流

1. 修改代码
2. 运行构建
3. 运行测试
4. 提交更改

## 示例项目

我们提供了完整的示例项目，供学习和参考：

| 示例 | 目录 | 功能 |
|------|------|------|
| Todo 应用 | `examples/todo-app` | 状态管理、UI 组件 |
| 博客系统 | `examples/blog-app` | API 路由、SSR/SSG、文件路由 |

## 许可证

MIT