小说开源项目novel-fpg安装与使用手册

小说开源项目novel-fpg安装与使用手册

novel-fpg小说开源项目，前端基于Flutter，后端是Python + Go双端，各自基于Flask、Gin实现了一遍，包含了用户注册、登录、jwt鉴权、签到、任务、书架、阅读器、购买章节、搜索书籍、绑定第三方账号、设置等功能。项目地址:https://gitcode.com/gh_mirrors/no/novel-fpg

1. 项目目录结构及介绍

novel-fpg是一个集成了前端与后端的小说应用开源项目。以下是其主要的目录结构概述：

novel-fpg/
├── frontend                # Flutter前端源代码目录
│   ├── lib                 # Flutter逻辑与组件代码
│   └── ...                 # 其他Flutter相关文件与资源
├── backend                 # 后端代码目录，包括Python与Go两个版本
│   ├── python              # 使用Flask框架的Python后端
│       ├── app.py          # 主程序入口
│       ├── config.py       # 配置文件
│       └── ...             # 控制器、模型等其他Python源码
│   ├── go                  # 使用Gin框架的Go后端
│       ├── main.go         # 程序入口
│       ├── config.go       # 配置文件
│       └── ...             # 路由、控制器等其他Go源码
├── resources               # 静态资源，如图片、配置文件等
├── docker-compose.yml      # Docker编排文件（可选）
├── README.md               # 项目说明文档
├── LICENSE                 # 许可证文件
└── ...                     # 其它辅助文件或文档

说明：

• frontend: 包含Flutter构建的移动应用界面代码。
• backend: 分为python和go子目录，分别存放Python和Go语言编写的后端服务代码。
• 配置文件在各自的后端目录下，以.py或.go的形式存在。

2. 项目的启动文件介绍

2.1 前端启动

前端的启动依赖于Flutter环境。确保已安装Flutter SDK，并配置好环境变量。进入frontend目录，运行以下命令来启动应用：

cd frontend
flutter run

2.2 后端启动

Python后端

在backend/python目录下，主启动文件是app.py。首先确保安装所有依赖，可以使用requirements.txt文件安装：

cd backend/python
pip install -r requirements.txt
python app.py

Go后端

对于Go后端，在backend/go目录中，启动文件为main.go。你需要先构建应用再运行：

cd backend/go
go build main.go
./main

3. 项目的配置文件介绍

• Python配置: backend/python/config.py包含了数据库连接、JWT密钥等关键配置项。

• Go配置: backend/go/config.go以Go结构体形式定义配置，包括数据库URL、端口号等，可能需要手动编辑以匹配你的部署环境。

注意：配置文件中的敏感信息如数据库密码应考虑使用环境变量来管理，以保证安全性。

以上步骤概括了novel-fpg的基本安装与启动流程。实际部署时还需考虑环境配置、数据库初始化以及必要的安全措施。

novel-fpg小说开源项目，前端基于Flutter，后端是Python + Go双端，各自基于Flask、Gin实现了一遍，包含了用户注册、登录、jwt鉴权、签到、任务、书架、阅读器、购买章节、搜索书籍、绑定第三方账号、设置等功能。项目地址:https://gitcode.com/gh_mirrors/no/novel-fpg