From c5b2c0556857adf5b7520176919f08f8ac507fe8 Mon Sep 17 00:00:00 2001
From: maticarmy <maticarmy@gmail.com>
Date: Mon, 10 Feb 2025 10:47:36 +0800
Subject: [PATCH] 1

---
 readme.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)

diff --git a/readme.md b/readme.md
index 67447e1..a6599ea 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,87 @@
+# Cursor API Admin 管理系统
+
+基于 ThinkPHP 框架开发的 API 管理系统。
+
+## 环境要求
+
+- PHP >= 7.2.5
+- MySQL >= 5.7
+- Composer
+
+## 安装步骤
+
+1. 克隆项目
+```bash
+git clone [你的项目地址]
+```
+
+2. 安装依赖
+```bash
+composer install
+```
+
+3. 配置环境
+- 复制 `.env.example` 为 `.env`
+- 修改数据库配置信息
+
+4. 初始化数据库
+```bash
+php think migrate:run
+```
+
+5. 启动服务
+```bash
+php think run
+```
+
+## 目录结构
+
+```
+├── app                        # 应用目录
+│   ├── admin                 # 后台管理模块
+│   ├── manager              # 管理员模块
+│   └── api                  # API 接口模块
+├── config                    # 配置文件目录
+├── public                    # Web 入口目录
+├── runtime                   # 运行时目录
+└── vendor                    # Composer 依赖目录
+```
+
+## 开发说明
+
+1. vendor 目录说明
+- 该目录包含项目依赖，不建议提交到 Git
+- 在 `.gitignore` 中已忽略 vendor 目录
+- 克隆项目后需要执行 `composer install` 安装依赖
+
+2. 配置文件
+- 敏感配置信息请放在 `.env` 文件中
+- `.env` 文件已在 `.gitignore` 中忽略
+
+## 常见问题
+
+1. 如果执行 `composer install` 速度较慢，可以使用阿里云镜像：
+```bash
+composer config -g repo.packagist composer https://mirrors.aliyun.com/composer/
+```
+
+2. 确保以下目录可写：
+- runtime/
+- public/uploads/
+
+## 维护说明
+
+- 代码更新后需要清理缓存：`php think clear`
+- 建议定期备份数据库
+- 线上部署建议使用 Nginx/Apache 配置
+
+## 安全建议
+
+- 定期更新依赖包：`composer update`
+- 及时备份数据
+- 修改默认管理员密码
+- 配置文件权限设置
+
 ## 大道至简 · 原生框架
 
 [![Latest Stable Version](https://poser.pugx.org/zoujingli/thinkadmin/v/stable)](https://packagist.org/packages/zoujingli/thinkadmin)