# lyx

**Repository Path**: fanzhongxing/lyx

## Basic Information

- **Project Name**: lyx
- **Description**: 简单好用的 Go-gin 脚手架生成工具
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-04
- **Last Updated**: 2026-03-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

LYX

本项目由 **lyx v0.1.0** 生成 – 一个轻量级、可扩展的 Go 项目脚手架工具。

---

## 项目概览

lyx 是一个基于 [Gin](https://github.com/gin-gonic/gin) 的基础 Go Web 项目，  
提供最小化结构，方便快速启动：

```
{{ .ProjectName }}/
├── cmd/server/main.go # 项目入口
├── internal/router/router.go # HTTP 路由配置
├── go.mod # Go module 文件
├── README.md
```
项目默认包含一个 `/ping` 接口：

```bash
curl http://localhost:8080/ping
# 返回: {"message":"pong"}
```

------

## 快速开始

### 1. 快速使用 lyx CLI

直接使用 Go 运行 lyx ，在 lyx 源码目录下执行：
```shell
go run . new myproject
```
即可生成名为 myproject 的 Gin 项目。

### 2. 启动服务

```bash
cd {{ .ProjectName }}
go run cmd/server/main.go
```

服务将运行在 **localhost:8080**。

### 3. 测试接口

```bash
curl http://localhost:8080/ping
```

预期返回：

```json
{"message":"pong"}
```

------

## lyx CLI 使用

本项目由 **lyx** CLI 创建。

- 创建新项目：

```bash
lyx new myproject
```

- 查看 lyx 版本：

```bash
lyx version
# 输出: v0.1.0
```

**说明：**

- CLI 使用 Go embed 打包模板
- 模板可在 `internal/generator/template/` 下自定义

------

## 项目结构说明

- `cmd/server` – 项目入口
- `internal/router` – HTTP 路由逻辑
- `go.mod` – Go module 文件，依赖自动管理
- `README.md` – 项目文档

------

## 未来可扩展功能

- 支持多模板（Gin Clean 架构、gRPC 等）
- 自动生成 CRUD 模块
- 数据库支持和 Docker 集成
- CLI 插件系统扩展功能

```
---

💡 特点：

1. 中文友好，容易被国内开发者理解  
2. 保留了模板变量 `{{ .ProjectName }}`，生成项目时自动替换  
3. 说明了目录结构、运行方法和默认接口  
4. 提示未来可扩展功能，便于开源和迭代  

---
```