Pic Smaller 开源项目使用手册

1. 项目目录结构及介绍

Pic Smaller 是一个易于使用的在线图像压缩工具，基于 Vite 和 React 构建。以下是其主要的目录结构及其简介：

pic-smaller
├── dockerignore           # Docker 忽略文件
├── Dockerfile             # Docker 容器构建文件
├── Dockerfile.slim        # 精简版Dockerfile
├── eslintrc.cjs           # ESLint 配置文件
├── gitignore              # Git 忽略文件
├── prettierrc             # Prettier 格式化配置
├── README.md               # 项目说明文档
├── index.html              # HTML入口文件
├── nginx.conf              # Nginx反向代理配置示例
├── package-lock.json      # npm包依赖锁文件
├── package.json           # npm包依赖及脚本定义
├── tsconfig.json           # TypeScript编译配置
├── tsconfig.node.json     # 特定于Node.js的TypeScript编译配置
├── vite.config.ts         # Vite构建配置文件
├── public                 # 静态资源文件夹
├── src                    # 源代码文件夹
│   ├── components         # 组件文件夹
│   ├── pages              # 页面文件夹
│   ├── utils              # 工具函数文件夹
│   └── ...                # 其它按功能划分的子目录
└── tests                  # 测试文件夹

2. 项目的启动文件介绍

项目的主要启动文件是通过Vite配置管理的，在 vite.config.ts 文件中定义了开发环境和生产环境的配置。开发者可以通过运行特定的npm脚本来启动项目：

• 开发模式下，使用命令 npm run dev 启动开发服务器。这将利用Vite的热重载功能，允许你在修改代码后立即看到效果。

• 构建生产版本，则需执行 npm run build，之后可以通过 serve 命令或手动部署到服务器上查看结果。

3. 项目的配置文件介绍

Vite配置 (vite.config.ts)

• 核心配置文件，负责项目编译、服务端配置、优化等。在这里你可以设置入口文件、公共路径、代理设置、打包选项等，对于项目开发和部署至关重要。

.env（未直接列出，但通常存在）

• 环境变量配置文件，用于存放敏感信息如API密钥等，并可根据不同的环境(.env.development, .env.production)提供不同的配置。

package.json

• 包含项目元数据、脚本指令和项目的依赖关系。关键的脚本包括dev、build以及可能自定义的其他脚本，是日常开发流程的核心操作指南。

TypeScript配置 (tsconfig.json, tsconfig.node.json)

• 规定了TypeScript编译成JavaScript时的行为，如目标版本、模块系统、源码目录、排除文件等。tsconfig.node.json特别用于处理Node.js相关编译需求。

在进行项目开发和配置调整时，理解这些文件的作用是至关重要的，确保你能高效地对项目进行定制和维护。通过遵循上述指引，您可以顺利地搭建和使用Pic Smaller项目。