Shamichan开源项目教程

Shamichan开源项目教程

shamichan anonymous realtime imageboard focused on high performance and transparent moderation 项目地址: https://gitcode.com/gh_mirrors/sh/shamichan

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

Shamichan 是一个基于匿名实时图像板的软件，以下是其主要目录结构及介绍：

shamichan/
├── .github/             # 存放GitHub工作流程文件
├── client/              # 客户端源代码目录
├── common/              # 通用库和模块目录
├── docker/              # Docker相关文件
├── docs/                # 项目文档
├── imager/              # 图像处理模块
├── lang/                # 国际化和本地化文件
├── less/                # 样式表文件
├── migrations/          # 数据库迁移脚本
├── scripts/             # 脚本文件
├── server/              # 服务器端源代码目录
├── static/              # 静态文件目录，如图片、CSS、JavaScript
├── to_port/             # 旧版本代码迁移目录
├── www/                 # Web服务器相关文件
├── .clang-format        # Clang格式化配置文件
├── .dockerignore        # Docker构建时排除的文件
├── .gitignore           # Git忽略的文件
├── .npmignore           # npm忽略的文件
├── .rustfmt.toml        # Rust格式化配置文件
├── COC.md               # 行为准则
├── Cargo.lock           # Rust依赖锁定文件
├── Cargo.toml           # Rust项目配置文件
├── Dockerfile           # Docker构建文件
├── Dockerfile.dev       # 开发环境Docker构建文件
├── LICENSE              # 项目许可证文件
├── Makefile             # Make构建脚本
├── README.md            # 项目介绍文件
├── go.mod               # Go依赖管理文件
├── go.sum               # Go依赖校验文件
├── package-lock.json    # npm依赖锁定文件
├── package.json         # npm项目配置文件

2. 项目的启动文件介绍

Shamichan 的启动主要通过 Makefile 脚本进行，以下是主要的启动命令：

• make: 默认构建命令，将编译服务器和客户端，并安装所需的依赖。
• make server: 仅构建服务器端代码。
• make client: 仅构建客户端代码。
• ./shamichan: 在调试模式下启动服务器。

在启动服务器之前，确保已经安装了所有必要的依赖项，并且配置了数据库。

3. 项目的配置文件介绍

Shamichan 的配置文件分为两部分：实例配置和服务器配置。

• 实例配置：存储在数据库中，可以通过项目的管理界面进行修改。
• 服务器配置：通常存储在 config.json 文件中，该文件在服务器启动时加载。一个示例配置文件可以在 docs/config.json 中找到，而详细的配置说明可以在 docs/config.jsonc 中查看。

确保在 config.json 文件中正确配置了数据库连接和其他必要的设置，以便服务器能够正确启动和运行。

shamichan anonymous realtime imageboard focused on high performance and transparent moderation 项目地址: https://gitcode.com/gh_mirrors/sh/shamichan