Excalidraw-CN 项目安装与使用教程

1. 项目目录结构及介绍

Excalidraw-CN 项目的目录结构如下：

excalidraw-cn/
├── codesandbox/
├── dev-docs/
├── firebase-project/
├── public/
├── scripts/
├── src/
├── .dockerignore
├── .editorconfig
├── .env.development
├── .env.production
├── .eslintignore
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .lintstagedrc.js
├── .npmrc
├── .nvmrc
├── .prettierignore
├── .watchmanconfig
├── CHANGELOG.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── README.md
├── crowdin.yml
├── docker-compose.yml
├── package.json
├── tsconfig-types.json
├── tsconfig.json
├── vercel.json
└── yarn.lock

目录结构介绍

• codesandbox/: 用于 CodeSandbox 的配置文件。
• dev-docs/: 开发文档目录。
• firebase-project/: Firebase 项目配置文件。
• public/: 公共资源文件，如图片、字体等。
• scripts/: 项目脚本文件。
• src/: 项目源代码目录，包含主要的业务逻辑。
• .dockerignore: Docker 忽略文件。
• .editorconfig: 编辑器配置文件。
• .env.development: 开发环境配置文件。
• .env.production: 生产环境配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc.json: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• .lintstagedrc.js: lint-staged 配置文件。
• .npmrc: npm 配置文件。
• .nvmrc: Node.js 版本配置文件。
• .prettierignore: Prettier 忽略文件。
• .watchmanconfig: Watchman 配置文件。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• crowdin.yml: Crowdin 翻译配置文件。
• docker-compose.yml: Docker Compose 配置文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig-types.json: TypeScript 类型配置文件。
• tsconfig.json: TypeScript 配置文件。
• vercel.json: Vercel 部署配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目启动文件介绍

项目的启动文件主要位于 src/ 目录下，其中 src/index.ts 是项目的入口文件。以下是主要的启动文件：

• src/index.ts: 项目的入口文件，负责初始化应用并启动服务。
• src/App.tsx: 应用的主组件，负责渲染整个应用的界面。
• src/main.tsx: 主模块文件，负责加载和配置应用的各个模块。

3. 项目配置文件介绍

项目的配置文件主要用于定义环境变量、构建配置、测试配置等。以下是主要的配置文件：

• .env.development: 开发环境配置文件，定义开发环境下的环境变量。
• .env.production: 生产环境配置文件，定义生产环境下的环境变量。
• .eslintrc.json: ESLint 配置文件，定义代码风格和规则。
• tsconfig.json: TypeScript 配置文件，定义 TypeScript 编译选项。
• tsconfig-types.json: TypeScript 类型配置文件，定义类型检查选项。
• docker-compose.yml: Docker Compose 配置文件，定义 Docker 容器的构建和运行配置。
• package.json: 项目依赖和脚本配置文件，定义项目的依赖包和脚本命令。

通过以上配置文件，可以灵活地配置和管理项目的开发、测试和生产环境。