Immich 开源项目教程

Immich 开源项目教程

immich项目地址:https://gitcode.com/gh_mirrors/imm/immich

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

Immich 是一个自托管的照片和视频备份解决方案。项目的目录结构如下：

immich/
├── apps/
│   ├── api/
│   ├── web/
│   └── mobile/
├── docker/
├── docs/
├── scripts/
└── README.md

• apps/: 包含项目的核心应用程序，分为 api（后端服务）、web（前端界面）和 mobile（移动应用）。
• docker/: 包含 Docker 配置文件，用于容器化部署。
• docs/: 包含项目文档，如 API 文档、用户指南等。
• scripts/: 包含一些辅助脚本，如数据库迁移脚本等。
• README.md: 项目的主介绍文件。

2. 项目的启动文件介绍

Immich 项目的启动文件主要位于 apps/ 目录下，具体如下：

• apps/api/src/main.ts: 后端服务的入口文件，负责启动 Express 服务器。
• apps/web/src/index.tsx: 前端界面的入口文件，负责渲染 React 应用。
• apps/mobile/App.tsx: 移动应用的入口文件，负责初始化 React Native 应用。

3. 项目的配置文件介绍

Immich 项目的配置文件主要用于设置环境变量和应用配置，具体如下：

• apps/api/.env: 后端服务的环境变量配置文件，包含数据库连接、端口等配置。
• apps/web/.env: 前端界面的环境变量配置文件，包含 API 地址、端口等配置。
• apps/mobile/.env: 移动应用的环境变量配置文件，包含 API 地址、端口等配置。

这些配置文件通常包含敏感信息，建议在部署时进行适当的保护和配置。

immich项目地址:https://gitcode.com/gh_mirrors/imm/immich