docs: readme

This commit is contained in:
CrescentLeaf
2025-10-06 12:05:12 +02:00
parent 71dee043a3
commit 8c8d17a1c7

102
readme.md
View File

@@ -1,81 +1,105 @@
## 铃之椅 ## 铃之椅
一个即时通讯项目——简单, 轻量, 纯粹, 时而天真 一个普通的即时通讯项目——简单, 轻量, 纯粹, 时而天真
__仍在积极开发中, 又名: the_white_silk__ *仍在积极开发中, 又名: the_white_silk*
### 目前實現了什麽? ### 基本功能
<details> <details>
<summary>戶端實現</summary> <summary>户端</summary>
- 消息 - 消息
- [x]消息 - [x]消息
- [x] 富文本 (based on Marked) - [x] 富文本 (based on Marked)
- [x] - [x]
- [x] 視頻 - [x] 视频
- [x] 文件 - [x] 文件
- [ ] 测试其他 Markdown 语法的可用性
- [ ] 撤回消息 - [ ] 撤回消息
- [ ] 修改消息 - [ ] 修改消息
- 對話 - 对话
- [x] 最近對話 - [x] 最近对话
- [x] 添加對話 - [x] 添加对话
- [x] 添加用 - [x] 添加用
- [x] 添加群 - [x] 添加群
- [ ] 群组管理 - [ ] 群组管理
- 賬號 - 帐号
- [x]錄注冊 (廢話) - [x]录注册
- [x] 資料編輯 - [x] 资料编辑
- [x] - [x]
- [x] - [x]
- [x] - [x]
- [ ] 賬號管理 - [ ] 帐号管理
- [ ]設密碼 - [ ]设密码
- [ ] 綁定郵 - [ ] 绑定邮
</details> </details>
<details> <details>
<summary>伺服器端實現</summary> <summary>服务端</summary>
- 基本對話類 - 基本对话类
- [x] 雙用戶私聊 - [x] 私聊
- [x] - [x]
- 消息 - 消息
- [x]消息 - [x]消息
- [ ] 撤回消息 - [ ] 撤回消息
- [ ] 修改消息 - [ ] 修改消息
- 對話 - 对话
- [x] 最近對話 - [x] 最近对话
- [x] 添加對話 - [x] 添加对话
- 賬號 - 帐号
- [x]錄注冊 - [x]录注册
- [x] 資料編輯 - [x] 资料编辑
- [ ] 賬號管理 - [ ] 帐号管理
- [ ]設密碼 - [ ]设密码
- [ ] 綁定郵 - [ ] 绑定邮
</details> </details>
### 伺服器端運行 ### 快速上手
```bash ```bash
git clone https://codeberg.org/CrescentLeaf/LingChair git clone https://codeberg.org/CrescentLeaf/LingChair
cd LingChair cd LingChair
# 編譯前端網頁 # 编译前端
deno task build deno task build
# 行服 # 行服
deno task server deno task server
``` ```
#### 配置 #### 配置
[thewhitesilk_config.json 是怎麽來的, 又有什麽用?](./server/config.ts) [thewhitesilk_config.json 是什么?](./server/config.ts)
### 使用的项目 / 技术栈
本项目由 Deno 驱动
- 前端
- 编译
- vite
- vite-plugin-babel
- react
- socket.io-client
- mdui
- split.js
- react-json-view
- dompurify
- marked
- 后端
- express
- socket.io
- chalk
- file-type
- cookie-parser
### License ### License