mirror of
https://github.com/jxxghp/MoviePilot.git
synced 2026-02-13 07:25:53 +08:00
62 lines
2.7 KiB
Markdown
62 lines
2.7 KiB
Markdown
# MoviePilot
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
基于 [NAStool](https://github.com/NAStool/nas-tools) 部分代码重新设计，聚焦自动化核心需求，减少问题同时更易于扩展和维护。
|
||
|
||
# 仅用于学习交流使用，请勿在任何国内平台宣传该项目！
|
||
|
||
发布频道：https://t.me/moviepilot_channel
|
||
|
||
## 主要特性
|
||
|
||
- 前后端分离，基于FastApi + Vue3，前端项目地址：[MoviePilot-Frontend](https://github.com/jxxghp/MoviePilot-Frontend)，API：http://localhost:3001/docs
|
||
- 聚焦核心需求，简化功能和设置，部分设置项可直接使用默认值。
|
||
- 重新设计了用户界面，更加美观易用。
|
||
|
||
## 安装使用
|
||
|
||
访问官方Wiki：https://wiki.movie-pilot.org
|
||
|
||
## 参与开发
|
||
|
||
需要 `Python 3.12`、`Node JS v20.12.1`
|
||
|
||
- 克隆主项目 [MoviePilot](https://github.com/jxxghp/MoviePilot)
|
||
```shell
|
||
git clone https://github.com/jxxghp/MoviePilot
|
||
```
|
||
- 克隆资源项目 [MoviePilot-Resources](https://github.com/jxxghp/MoviePilot-Resources) ，将 `resources` 目录下对应平台及版本的库 `.so`/`.pyd`/`.bin` 文件复制到 `app/helper` 目录
|
||
```shell
|
||
git clone https://github.com/jxxghp/MoviePilot-Resources
|
||
```
|
||
- 安装后端依赖，设置`app`为源代码根目录，运行 `main.py` 启动后端服务，默认监听端口：`3001`，API文档地址：`http://localhost:3001/docs`
|
||
```shell
|
||
pip install -r requirements.txt
|
||
python3 main.py
|
||
```
|
||
- 克隆前端项目 [MoviePilot-Frontend](https://github.com/jxxghp/MoviePilot-Frontend)
|
||
```shell
|
||
git clone https://github.com/jxxghp/MoviePilot-Frontend
|
||
```
|
||
- 安装前端依赖，运行前端项目，访问：`http://localhost:5173`
|
||
```shell
|
||
yarn
|
||
yarn dev
|
||
```
|
||
- 参考 [插件开发指引](https://wiki.movie-pilot.org/zh/plugindev) 在 `app/plugins` 目录下开发插件代码
|
||
|
||
## 贡献者
|
||
|
||
<a href="https://github.com/jxxghp/MoviePilot/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=jxxghp/MoviePilot" />
|
||
</a>
|