MediaGo 项目安装与使用教程

1. 项目的目录结构及介绍

MediaGo 项目的目录结构如下：

mediago/
├── docs/
├── packages/
├── patches/
├── screenshot/
├── scripts/
├── .editorconfig
├── .env.development
├── .env.production
├── .gitignore
├── .hintrc
├── .npmrc
├── .prettierignore
├── .prettierrc
├── LICENSE
├── README.md
├── commitlint.config.js
├── cspell.json
├── eslint.config.js
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── tsconfig.json

目录结构介绍

• docs/: 存放项目文档文件。
• packages/: 存放项目的各个包或模块。
• patches/: 存放项目的补丁文件。
• screenshot/: 存放项目的截图文件。
• scripts/: 存放项目的脚本文件。
• .editorconfig: 编辑器配置文件。
• .env.development: 开发环境配置文件。
• .env.production: 生产环境配置文件。
• .gitignore: Git 忽略文件配置。
• .hintrc: 代码质量检查配置文件。
• .npmrc: npm 配置文件。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc: Prettier 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• commitlint.config.js: commitlint 配置文件。
• cspell.json: 拼写检查配置文件。
• eslint.config.js: ESLint 配置文件。
• package.json: 项目依赖和脚本配置文件。
• pnpm-lock.yaml: pnpm 锁定文件。
• pnpm-workspace.yaml: pnpm 工作区配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

MediaGo 项目的启动文件主要包括以下几个部分：

开发环境启动

在开发环境中，可以使用以下命令启动项目：

pnpm dev

打包运行

在生产环境中，可以使用以下命令打包并运行项目：

pnpm release

3. 项目的配置文件介绍

MediaGo 项目的主要配置文件包括：

.env.development 和 .env.production

这两个文件分别用于配置开发环境和生产环境的环境变量。例如：

# .env.development
NODE_ENV=development
PORT=3000

# .env.production
NODE_ENV=production
PORT=8080

package.json

package.json 文件包含了项目的依赖、脚本命令等信息。例如：

{
  "name": "mediago",
  "version": "1.0.0",
  "scripts": {
    "dev": "pnpm run dev",
    "release": "pnpm run release"
  },
  "dependencies": {
    "react": "^17.0.2",
    "electron": "^12.0.0"
  }
}

tsconfig.json

tsconfig.json 文件用于配置 TypeScript 编译选项。例如：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "CommonJS",
    "strict": true
  }
}

eslint.config.js

eslint.config.js 文件用于配置 ESLint 代码检查规则。例如：

module.exports = {
  rules: {
    "no-console": "off",
    "indent": ["error", 2]
  }
};

通过以上配置文件，可以灵活地调整项目的运行环境和代码规范。