Wizarr 开源项目教程

Wizarr 开源项目教程

wizarrWizarr is an advanced user invitation and management system for Jellyfin, Plex, Emby etc.项目地址:https://gitcode.com/gh_mirrors/wi/wizarr

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

Wizarr 项目的目录结构如下：

wizarrrr/wizarr/
├── apps/
├── dockerfiles/
├── docs/
├── files/
├── modules/
├── scripts/
├── .dockerignore
├── .editorconfig
├── .eslintignore
├── .eslintrc.json
├── .gitignore
├── .hintrc
├── .prettierignore
├── .prettierrc
├── CHANGELOG-beta.md
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── ca_profile.xml
├── commitlint.config.js
├── develop.code-workspace
├── latest.code-workspace
├── nx.json
├── package-lock.json
├── package.json
├── release.config.cjs
├── tsconfig.base.json
├── unraid.xml
├── wizarr.code-workspace

目录介绍

• apps/: 存放应用程序的主要代码。
• dockerfiles/: 存放 Docker 配置文件。
• docs/: 存放项目文档。
• files/: 存放项目所需的文件。
• modules/: 存放项目的模块代码。
• scripts/: 存放脚本文件。
• .dockerignore: Docker 忽略文件。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .hintrc: Webhint 配置文件。
• .prettierignore: Prettier 忽略文件。
• .prettierrc: Prettier 配置文件。
• CHANGELOG-beta.md: 测试版更新日志。
• CHANGELOG.md: 正式版更新日志。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.md: 许可证文件。
• README.md: 项目说明文档。
• ca_profile.xml: CA 配置文件。
• commitlint.config.js: Commitlint 配置文件。
• develop.code-workspace: 开发工作区配置文件。
• latest.code-workspace: 最新工作区配置文件。
• nx.json: Nx 配置文件。
• package-lock.json: npm 锁定文件。
• package.json: npm 配置文件。
• release.config.cjs: 发布配置文件。
• tsconfig.base.json: TypeScript 基础配置文件。
• unraid.xml: Unraid 配置文件。
• wizarr.code-workspace: Wizarr 工作区配置文件。

2. 项目的启动文件介绍

Wizarr 项目的启动文件主要是 package.json 中的 scripts 部分。以下是一些关键的启动脚本：

{
  "scripts": {
    "start": "node index.js",
    "dev": "nodemon index.js",
    "build": "webpack",
    "test": "jest"
  }
}

启动脚本介绍

• start: 启动生产环境服务器。
• dev: 启动开发环境服务器，使用 nodemon 实现自动重启。
• build: 构建项目，使用 webpack 进行打包。
• test: 运行测试，使用 jest 进行单元测试。

3. 项目的配置文件介绍

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

• .env: 环境变量配置文件。
• config.js: 应用程序配置文件。
• docker-compose.yml: Docker 容器配置文件。

配置文件介绍

• .env: 用于存储敏感信息和环境变量，如数据库连接字符串、API 密钥等。
• config.js: 包含应用程序的各种配置选项，如端口号、数据库配置、日志级别等。
• docker-compose.yml: 定义 Docker 容器的配置，包括服务、网络和卷的设置。

version: '3.8'
services:
  wizarr:

wizarrWizarr is an advanced user invitation and management system for Jellyfin, Plex, Emby etc.项目地址:https://gitcode.com/gh_mirrors/wi/wizarr