Miruro 项目教程

Miruro 项目教程

Miruro 🍜 Miruro is an Anime Streaming Site with minimal UI and ad-free experience. Made with React. 🚧 Under Maintenance 项目地址: https://gitcode.com/gh_mirrors/mir/Miruro

1. 项目目录结构及介绍

Miruro 项目的目录结构如下：

Miruro/
├── .github/
├── api/
├── functions/
├── public/
├── server/
├── src/
├── .env.example
├── .eslintrc.cjs
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── index.html
├── package.json
├── renovate.json
├── robots.txt
├── tsconfig.json
├── tsconfig.node.json
├── vercel.json
└── vite.config.ts

• .github/：包含与 GitHub 相关的配置文件，如 .github/workflows 目录中的 CI/CD 流程文件。
• api/：可能包含与后端 API 相关的代码和文件。
• functions/：可能包含云函数或服务端函数的代码。
• public/：存放公共静态文件，如图片、CSS 文件和 JavaScript 文件。
• server/：包含服务器端的代码和配置。
• src/：项目的主要源代码目录，通常包含所有的前端代码。
• .env.example：环境的示例配置文件，用于展示如何配置环境变量。
• .eslintrc.cjs：ESLint 的配置文件，用于定义代码风格规则。
• .gitignore：Git 忽略文件，指定 Git 应该忽略的文件和目录。
• .prettierrc：Prettier 的配置文件，用于定义代码格式化规则。
• LICENSE：项目的许可证文件，本项目使用自定义 BY-NC 许可证。
• README.md：项目的自述文件，包含项目的介绍、使用方法和贡献指南。
• index.html：项目的入口 HTML 文件。
• package.json：项目的 npm 配置文件，定义了项目的依赖、脚本和元数据。
• renovate.json：Renovate 的配置文件，用于自动化依赖项更新。
• robots.txt：用于控制搜索引擎抓取策略的文件。
• tsconfig.json：TypeScript 的配置文件，定义了项目的类型检查和编译选项。
• tsconfig.node.json：Node.js 环境下的 TypeScript 配置文件。
• vercel.json：Vercel 的配置文件，用于部署项目时自定义设置。
• vite.config.ts：Vite 的配置文件，用于配置前端构建和开发服务器。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 中的脚本实现：

• bun run dev：使用 Bun 运行开发服务器，开始开发模式。
• bun start：使用 Bun 启动生产环境的服务器。

在开发模式下，Bun 会监视源代码的更改，并在更改时重新编译和加载应用程序。在生产模式下，Bun 会构建应用程序并启动一个优化的服务器。

3. 项目的配置文件介绍

项目的配置主要涉及以下几个文件：

• .env.example：这个文件包含了所有需要的环境变量的示例。在实际使用时，需要将其复制为 .env.local 并填入实际的值。
• tsconfig.json：TypeScript 配置文件，用于配置 TypeScript 编译器的选项，例如包含的文件、排除的文件和编译选项。
• vite.config.ts：Vite 配置文件，用于定制 Vite 的行为，如指定构建输出、代理设置、环境变量等。

确保在使用项目之前正确配置了这些文件，以便项目可以正确运行。

Miruro 🍜 Miruro is an Anime Streaming Site with minimal UI and ad-free experience. Made with React. 🚧 Under Maintenance 项目地址: https://gitcode.com/gh_mirrors/mir/Miruro