TextUSM 项目使用教程
1. 项目的目录结构及介绍
TextUSM 是一个用于从缩进文本生成用户故事地图的在线工具。以下是项目的目录结构及其介绍:
textusm/
├── assets/ # 静态资源文件
├── backend/ # 后端代码
├── cli/ # 命令行工具
├── extension/ # VSCode 扩展
├── frontend/ # 前端代码
├── tools/fontlist/ # 字体列表工具
├── .editorconfig # 编辑器配置文件
├── .firebaserc # Firebase 配置文件
├── .gitignore # Git 忽略文件配置
├── .tool-versions # 工具版本配置
├── LICENSE # 许可证文件
├── README.md # 项目说明文档
├── firebase.json # Firebase 配置
├── firestore.indexes.json # Firestore 索引配置
├── justfile # Just 任务运行文件
├── storage.rules # 存储规则
2. 项目的启动文件介绍
TextUSM 项目的启动文件主要位于 frontend
和 backend
目录中。以下是主要的启动文件及其介绍:
frontend/src/index.js
: 前端应用的入口文件,负责初始化前端应用。backend/index.js
: 后端服务的入口文件,负责启动后端服务器。
3. 项目的配置文件介绍
TextUSM 项目的配置文件主要用于配置开发和生产环境。以下是主要的配置文件及其介绍:
.firebaserc
: Firebase 项目配置文件,包含项目 ID 和默认配置。firebase.json
: Firebase 服务配置文件,包含托管、函数等服务的配置。firestore.indexes.json
: Firestore 数据库索引配置文件。storage.rules
: Firebase 存储规则配置文件,定义存储访问权限。
以上是 TextUSM 项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 TextUSM 项目。