https://github.com/xubeiyan/nimingban
an Adao like anonymous board, but with modern UI
https://github.com/xubeiyan/nimingban
anonymous-board postgresql svelte-kit svelte4 tailwindcss
Last synced: about 2 months ago
JSON representation
an Adao like anonymous board, but with modern UI
- Host: GitHub
- URL: https://github.com/xubeiyan/nimingban
- Owner: xubeiyan
- License: mit
- Created: 2024-04-03T15:34:31.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2026-04-22T10:05:19.000Z (2 months ago)
- Last Synced: 2026-04-22T10:13:10.760Z (2 months ago)
- Topics: anonymous-board, postgresql, svelte-kit, svelte4, tailwindcss
- Language: Svelte
- Homepage: https://nimingban.chenhai.net
- Size: 715 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nimingban
## 简介
#### 一个类似于A岛（已停止运营）或者2chan，4chan的匿名版论坛
- 使用 `SvelteKit` 元框架，搭配 `Svelte v4`
- 样式库使用 `TailwindCSS v3`
- 数据库使用 `PostgresSQL`
## 支持功能
### 普通用户
- [x] 明亮/黑暗模式
- [x] 注册用户
- [x] 登录用户
- [x] 申请饼干（匿名版常用需要饼干才能发帖）
- [x] 多饼干切换
- [x] 密码修改
- [x] 两层版块（第一层称作分区，第二层称作版块）
- [x] 发串或者评论支持 `Markdown` 语法，有预览功能，具体参考[这里](#markdown-编辑器支持语法)
- [x] 回复也支持 `Markdown` 语法（笑看某V2EX
- [x] (作者)编辑串或者评论，会增加编辑标记，可增加发送时忘记添加的图片
### 管理者
- [x] 串管理（编辑、修改可见性、移动串至其他板块、删除）
- [x] 版块管理（新建，删除，修改，列表）
- [x] 版块简介支持 `Markdown` 语法
- [x] 用户和饼干管理（查询，修改可用性）
- [x] 匿名版参数修改（网站名，JWT）
- [x] 增加 `web` 界面的安装过程
- [x] 管理者添加和更新（在安装过程中配置）
- [x] 管理者可以重置用户密码，将其设为随机字符串，供用户找回
- [x] 管理者编辑串或者评论
## 路由设计
点击展开路由设计
| 功能 | 路径（和请求方法） | 携带参数 |
| -------------------------------- | --------------------------------------- | -------- |
| 主页 | GET / | |
| 某个版 | GET /board/{board_url} | |
| （管理）编辑某串或评论 | POST /board/editPostOrComment/{post_id} | |
| 获取某个版的串 | GET /board/getPosts/{board_url} | |
| 发送串 | POST /board/sendPost/{board_url} | |
| 发送回复串 | POST /board/sendComment/{post_id} | |
| 获取某串回复 | GET /comment/{post_id} | |
| 获取某串最新回复 | GET /comment/latest/{post_id} | |
| 获取单独某条回复 | GET /comment/single/{comment_id} | |
| 获取某串包含的图片 | GET /getImages/fromPostOrComment/{id} | |
| 查看某串 | GET /post/{post_id} | |
| 登录 | POST /login | |
| （管理）添加版块 | POST /manage/addBoard | |
| （管理）添加分区 | POST /manage/addSection | |
| （管理）编辑串状态 | POST /manage/editPostStatus/{id} | |
| （管理）获取版块列表 | GET /manage/getBoardList/{id} | |
| （管理）获取分区列表 | GET /manage/getSectionList | |
| （管理）获取网站设置 | GET /manage/getSettingList | |
| （管理）移动串 | POST /manage/movePost | |
| （管理）获取完整版块列表 | GET /manage/movePost/getFullBoardList | |
| （管理）删除版块 | GET /manage/removeBoard/{id} | |
| （管理）删除评论 | GET /manage/removeComment/{id} | |
| （管理）删除串 | GET /manage/removePost/{id} | |
| （管理）删除分区 | GET /manage/removeSection/{id} | |
| （管理）将用户变更为重置密码状态 | POST /manage/resetPassword | |
| （管理）搜索用户或饼干 | POST /manage/searchCookies | |
| （管理）搜索用户详细信息 | POST /manage/searchUser | |
| （管理）切换用户或饼干状态 | POST /manage/toggleUserStatus | |
| （管理）更新版块 | POST /manage/updateBoard | |
| （管理）更新分区 | POST /manage/updateSection | |
| （管理）更新网站设置 | POST /manage/updateSetting | |
| 注册 | POST /register | |
| 获取饼干 | GET /user/getNewCookies | |
| 刷新JWT | POST /user/refreshJWT | |
| 修改密码 | POST /user/updatePassword | |
| 重置密码 | POST /user/resetPassword | |
## 参数设置
- `site_name` 匿名版名称
- `jwt_secert` JWT 密钥
- `jwt_expire_minute` JWT 密钥过期时间
## 表设计
### section
点击展开 区域名 表设计
| 列名 | 数据类型 | 备注 |
| ------------ | ---------- | ---- |
| id | uuid | |
| section_name | vchar(256) | |
| order | integer | |
### board
点击展开 版块 表设计
| 列名 | 数据类型 | 备注 |
| ------------------ | ---------- | --------------------------------- |
| id | uuid | |
| parent_section_id | uuid | |
| min_post_second | integer | default 10 |
| min_post_timestamp | timestamp | |
| access_type | vchar(16) | 可选值 `all` `view_only` `hidden` |
| name | vchar(256) | |
| url_name | vchar(256) | |
| intro | text | |
| order | integer | |
### post
点击展开 串 表设计
| 列名 | 数据类型 | 备注 |
| ----------------- | ---------- | -------------------------------------- |
| id | uuid | |
| status | vchar(16) | 可选值 `repliable` `readonly` `hidden` |
| belong_board_id | uuid | |
| poster_name | vchar(256) | |
| poster_email | vchar(256) | |
| title | vchar(256) | |
| content | text | |
| poster_cookies_id | uuid | |
| post_timestamp | timestamp | |
| edit_timestamp | timestamp | |
### post_comment_image
点击展开 串内图像 表设计
| 列名 | 数据类型 | 备注 |
| ---------- | ---------- | -------------------------------------- |
| id | uuid | |
| image_type | vchar(16) | 可用值 `png` `jpg` `gif` `webp` `avif` |
| exist_type | vchar(16) | 可用值 `exist` `hidden` `remove` |
| post_id | uuid | |
| fullname | vchar(128) | |
### comment
点击展开 评论 表设计
| 列名 | 数据类型 | 备注 |
| -------------- | ---------- | ---- |
| id | uuid | |
| belong_post_id | uuid | |
| poster_name | vchar(256) | |
| poster_email | vchar(256) | |
| title | vchar(256) | |
| content | text | |
| post_timestamp | timestamp | |
| edit_timestamp | timestamp | |
### user
点击展开 用户 表设计
| 列名 | 数据类型 | 备注 |
| ---------------- | ---------- | -------------------------------------------- |
| id | uuid | |
| status | vchar(16) | 可用值 `enable` `disable` |
| username | vchar(256) | |
| password_hash | vchar(128) | |
| password_salt | vchar(128) | |
| type | vchar(16) | 可用值 `admin` `user` |
| create_timestamp | timestamp | |
| reset_password | vchar(128) | 有值则处于密码重置状态，且此值为重置后的代码 |
### cookies
点击展开 用户饼干 表设计
| 列名 | 数据类型 | 备注 |
| ---------------- | --------- | ------------------------- |
| id | uuid | |
| belong_user_id | uuid | |
| create_timestamp | timestamp | |
| expire_timestamp | timestamp | |
| content | vchar(32) | |
| status | vchar(16) | 可用值 `enable` `disable` |
### site_settings
点击展开 网站设定 表设计
| 列名 | 数据类型 | 备注 |
| ----------- | ---------- | ---- |
| name | vchar(64) | |
| data_type | vchar(64) | |
| value | vchar(128) | |
| description | vchar(256) | |
| 支持的值 | 说明 | 数据类型 | 默认值 |
| ------------ | ------------------- | -------- | ------------------- |
| site_name | 站点名称 | "string" | "匿名版" |
| cookie_limit | 饼干限制 | "number" | "5" |
| jwt_secret | JSON Web Token 密钥 | "string" | "nimingban20241011" |
## Markdown 编辑器支持语法
- [x] `heading` h1~h4
- [x] `text`
- [x] `paragraph`
- [x] `emphasis`
- [x] `strong`
- [x] `inlineCode`
- [x] `code`
- [x] 支持用``标签代替 result 代码块
- [x] `delete`
- [x] `hr`
- [x] `blockquote`
- [x] `link`
- [x] `image`
- [x] 支持带图片说明文字插入，居中且有文字说明
- [x] `list`
- [x] 支持有序和无序列表
- [x] 支持多层级的列表（最大 3 层）
- [x] `table`
- [x] `spoiler` 参考了 reddit `>! hidden text !<`
- [x] `kbd` 使用 `[[...]]` 来实现
- [x] `katexmath` 使用`KatexMath`来实现数学公式的显示，支持行内和块两种显示方式
## 使用方法
### 前置要求
1. PostgreSQL
配置好可用的 PostgreSQL 服务，例如
```
PGHOST=localhost
PGUSER=postgres
PGDATABASE=nimingban
PGPASSWORD=postgres
PGPORT=5432
```
2. 运行环境
目前只在 `node` 下进行了测试，`bun` 或者 `deno` 尚未测试，欢迎测试并提出 PR
已测试 `v18.20.5` 和 `v20.17.0`
### 打包流程
1. Clone 项目
```shell
# clone到当前目录
$ git clone https://github.com/xubeiyan/nimingban ./nimingban
```
2. 安装依赖
假设使用 `pnpm`，其他包管理类似
```shell
$ cd nimingban
# P参数只安装运行依赖
$ pnpm i -P
```
3. 进行打包
会生成在 `./nimingban/build` 文件夹内
```shell
$ pnpm build
```
4. 配置环境变量文件
将 `.env.example` 文件复制为 `.env`，并修改里面的内容
```shell
$ cp .env.example .env
$ nvim .env
```
修改 `IMAGE_UPLOAD_PATH` 至可用的位置，`./uploadImages` 表示`nimingban/uploadImages` 文件夹
```
# 图片上传位置
IMAGE_UPLOAD_PATH=./uploadImages
```
5. 启动项目
```shell
$ node build/index.js
```
但实际项目中一般会有域名指向此项目，例如`https://nimingban.name.net`，需要设定 `ORIGIN`，否则提交表单会发生跨域错误
```shell
# linux 指定环境变量
$ ORIGIN=https://nimingban.name.net node build/index.js
```
```bat
> REM windows 指定环境变量
> set ORIGIN=https://nimingban.name.net
> node build\index.js
```
### 生产环境额外配置
1. 配置 `Web` 服务器直接处理图片请求加快图像访问（以 `nginx` 为例）
```conf
# /etc/nginx/site-avaliable/nimingban.name.net
server {
...
# 指定 /images/ 路径
location /images/ {
alias /opt/nimingban/uploadImages/;
}
...
}
```