开源项目Flox安装与使用指南

开源项目Flox安装与使用指南

flox Self Hosted Movie, Series and Anime Watch List 项目地址: https://gitcode.com/gh_mirrors/flo/flox

项目简介

Flox是一款基于Laravel和Vue.js构建的自托管电影、电视剧和动漫观看列表应用。它利用The Movie Database (TMDb) API来提供数据支持，并采用一个简易的三阶评分系统（好、中、坏）。本指南将引导您了解其基本架构、启动步骤以及关键配置文件。

1. 项目目录结构及介绍

Flox的项目结构是典型的Laravel项目布局，包含以下主要目录：

• backend：后端代码所在，包括PHP逻辑、数据库迁移文件等。

  • app：核心业务逻辑，控制器、模型、中间件等。
  • database：包含迁移(migrations)和种子(seeds)文件。
  • routes：API路由和Web界面路由定义。
  • .env：环境变量配置文件。
  • public：前端资源静态访问入口，如CSS、JavaScript和图片。

• client：前端Vue.js应用程序，处理用户界面交互。

  • 包含Vue组件、资产、样式表等。

• public：用于存放可公开访问的文件，如由后台生成的导出数据或静态资源。

• 其他标准Laravel目录如config, storage, 和 resources 等，用于存储配置、日志、视图模板和本地化文件。

2. 项目的启动文件介绍

主要启动流程

1. Backend 启动: 核心在于运行Laravel应用程序，主要通过执行命令行工具。

   • 使用php artisan serve可快速启动开发服务器（需先完成安装）。

2. Frontend 启动: 对于Vue.js部分，开发者应进入client目录执行npm run serve或yarn serve以启动开发服务器。

关键启动脚本

• Artisan 命令 (php artisan):

  • install:flox: 初始化项目设置，包括数据库配置请求。
  • flox:db: 运行数据库迁移，创建表结构。
  • queue:work: 起动队列工作器处理异步任务，如数据刷新和Plex同步。
  • schedule:run: 执行计划任务，自动更新数据等。

• 前端构建:

  • 在client目录下执行npm install进行依赖安装。
  • 接着，运行npm run dev或yarn serve用于编译并热重载前端应用。

3. 项目的配置文件介绍

主要配置文件

.env 文件

位于backend/.env，是项目的核心配置文件，包含但不限于：

• 数据库连接信息：DB_DATABASE, DB_USERNAME, DB_PASSWORD等。
• APP_URL：应用程序的基础URL，对API和前端路由至关重要。
• TMDB_API_KEY：从The Movie Database获取的API密钥。
• CLIENT_URI：前端应用访问的路径，对于多级路径部署尤为重要。

config/app.php

此文件控制Laravel应用的行为，包括时区、语言、中间件、路由前缀等基本设置。也是注册服务提供商的地方。

backend/database/.env

虽然不在常规配置文件之列，但用于特定于数据库迁移的环境变量配置，比如数据库凭证。

Other Configuration Files

在config目录下还有多个文件，如services.php, filesystems.php, 等，用于进一步定制应用程序的服务和行为。

综上所述，Flox项目通过结合精细的后端管理和响应式的前端展示，提供了完整的自托管媒体追踪体验。正确理解和配置这些关键要素，是顺利部署和使用Flox的前提条件。

flox Self Hosted Movie, Series and Anime Watch List 项目地址: https://gitcode.com/gh_mirrors/flo/flox