NovaScript

一个现代化的实时一对一聊天应用，支持 Markdown 格式和丰富的消息功能。

功能特点

• 实时聊天功能
• Markdown 格式支持
• 代码高亮显示
• LaTeX 数学公式支持
• Mermaid 图表支持
• 表情符号支持
• 用户认证和授权
• 在线状态显示
• 响应式设计
• 图片 Lightbox 预览
  • 支持图片放大查看
  • 支持图片幻灯片播放
  • 支持键盘快捷键操作
  • 支持触摸屏手势操作

技术栈

• 后端

  • Node.js
  • Express.js
  • Socket.IO
  • bcryptjs

• 前端

  • HTML5
  • CSS3
  • JavaScript
  • Socket.IO Client
  • Marked.js (Markdown 解析)
  • Highlight.js (代码高亮)
  • KaTeX (数学公式)
  • Mermaid (图表)
  • Emoji Toolkit

安装步骤

方式一：直接部署

1. 克隆仓库：

git clone https://github.com/davoola/NovaScript.git
cd NovaScript

2. 安装依赖：

npm install

3. 初始化用户配置：

# 创建必要的目录
mkdir -p data/chats public/uploads

# 从示例文件创建用户配置
cp data/users.json.example data/users.json

4. 创建环境变量文件（可选）：

cp .env.example .env

然后编辑 .env 文件配置你的环境变量。

5. 启动服务器：

npm start

默认情况下，应用将在 http://localhost:3000 运行。

方式二：Docker 部署

1. 使用 Docker Compose 部署（推荐）：

# 克隆仓库
git clone https://github.com/davoola/NovaScript.git
cd NovaScript

# 创建必要的目录
mkdir -p data/chats public/uploads

# 初始化用户配置
cp data/users.json.example data/users.json

# 创建并编辑环境变量文件（可选）
cp .env.example .env

# 构建并启动容器
docker-compose up -d

2. 使用 Docker 直接部署：

# 克隆仓库
git clone https://github.com/davoola/NovaScript.git
cd NovaScript

# 创建必要的目录
mkdir -p data/chats public/uploads

# 初始化用户配置
cp data/users.json.example data/users.json

# 构建镜像
docker build -t novascript .

# 运行容器
docker run -d \
  -p 3000:3000 \
  -v $(pwd)/data/users.json:/app/data/users.json \
  -v $(pwd)/data/chats:/app/data/chats \
  -v $(pwd)/public/uploads:/app/public/uploads \
  --name novascript \
  novascript

访问 http://localhost:3000 即可使用应用。

Docker 部署注意事项

1. 数据持久化：

   • 用户配置存储在 data/users.json 中
   • 聊天记录存储在 data/chats 目录中
   • 上传的文件存储在 public/uploads 目录中
   • Docker 部署时会自动挂载这些目录
   • 请定期备份这些目录的内容

2. 环境变量：

   • 可以通过 .env 文件或在 docker-compose.yml 中配置环境变量
   • 生产环境建议使用 Docker secrets 或环境变量管理工具

3. 性能优化：

   • 容器默认使用 Node.js 生产模式运行
   • 如需调整内存限制，可在 docker-compose.yml 中添加配置

4. 安全建议：

   • 生产环境建议使用 HTTPS
   • 可以配置反向代理（如 Nginx）
   • 定期更新基础镜像和依赖

使用说明

1. 访问 http://localhost:3000 进入登录页面
2. 使用用户名和密码登录
3. 进入聊天界面后即可开始聊天
4. 支持以下特殊格式：
   • Markdown 语法
   • 代码块（支持语法高亮）
   • LaTeX 数学公式
   • Mermaid 图表
   • 表情符号

Markdown 语法

支持标准的 Markdown 语法，包括：

• 标题（# 一级标题，## 二级标题，等等）
• 列表（有序和无序）
• 链接和图片
• 粗体和斜体
• 引用
• 表格
• 任务列表

数学公式

使用 LaTeX 语法在 $ 符号之间编写行内公式，或在 $$ 符号之间编写块级公式：

行内公式：$E = mc^2$
块级公式：
$$
\frac{d}{dx}e^x = e^x
$$

Mermaid 图表

支持多种类型的 Mermaid 图表，使用 ```mermaid 代码块：

1. 流程图（横向和纵向）

```mermaid
graph LR
    A[开始] --> B{判断}
    B -->|是| C[处理]
    B -->|否| D[结束]
    C --> D

#### 2. 时序图

sequenceDiagram
    participant 客户端
    participant 服务器
    客户端->>服务器: 请求数据
    服务器-->>客户端: 返回数据

Loading

#### 3. 甘特图

gantt
    title 项目计划
    dateFormat YYYY-MM-DD
    section 阶段1
    需求分析 :a1, 2023-01-01, 7d
    设计     :a2, after a1, 10d
    section 阶段2
    开发     :a3, after a2, 15d
    测试     :a4, after a3, 5d

Loading

聊天界面右下角的帮助按钮提供了更多图表语法示例。

### 图片预览功能

在聊天中发送的图片支持以下功能：
1. 点击图片可放大查看
2. 支持以下操作：
   - 左右箭头键：切换上一张/下一张图片
   - 空格键：开始/暂停幻灯片播放
   - Esc 键：退出预览
   - 鼠标滚轮：缩放图片
   - 双击图片：切换原始大小/适应屏幕
3. 触摸屏操作：
   - 双指缩放
   - 左右滑动切换图片
   - 双击放大/缩小

## 开发模式

运行开发服务器：
```bash
npm run dev

安全说明

• 密码在传输和存储时进行加密处理
• WebSocket连接也需要认证令牌

目录结构

.
├── public/             # 静态文件
│   ├── css/           # 样式文件
│   ├── js/            # 客户端JavaScript
│   ├── images/        # 图片资源
│   ├── index.html     # 主页面
│   └── login.html     # 登录页面
├── data/              # 数据存储
├── server.js          # 服务器入口文件
├── package.json       # 项目配置
└── README.md          # 项目文档

贡献指南

欢迎提交 Pull Requests 来改进这个项目。在提交之前，请确保：

1. 代码符合现有的代码风格
2. 添加了适当的测试
3. 更新了相关文档

许可证

MIT License

部署方式

方式一：直接部署

// ... existing code ...

方式二：Docker 部署

1. 使用 Docker Compose 部署（推荐）：

# 克隆仓库
git clone https://github.com/davoola/NovaScript.git
cd NovaScript

# 创建必要的目录
mkdir -p data/chats public/uploads

# 初始化用户配置
cp data/users.json.example data/users.json

# 创建并编辑环境变量文件（可选）
cp .env.example .env

# 构建并启动容器
docker-compose up -d

2. 使用 Docker 直接部署：

# 克隆仓库
git clone https://github.com/davoola/NovaScript.git
cd NovaScript

# 创建必要的目录
mkdir -p data/chats public/uploads

# 初始化用户配置
cp data/users.json.example data/users.json

# 构建镜像
docker build -t novascript .

# 运行容器
docker run -d \
  -p 3000:3000 \
  -v $(pwd)/data/users.json:/app/data/users.json \
  -v $(pwd)/data/chats:/app/data/chats \
  -v $(pwd)/public/uploads:/app/public/uploads \
  --name novascript \
  novascript

访问 http://localhost:3000 即可使用应用。

Docker 部署注意事项

1. 数据持久化：

   • 用户配置存储在 data/users.json 中
   • 聊天记录存储在 data/chats 目录中
   • 上传的文件存储在 public/uploads 目录中
   • Docker 部署时会自动挂载这些目录
   • 请定期备份这些目录的内容

2. 环境变量：

   • 可以通过 .env 文件或在 docker-compose.yml 中配置环境变量
   • 生产环境建议使用 Docker secrets 或环境变量管理工具

3. 性能优化：

   • 容器默认使用 Node.js 生产模式运行
   • 如需调整内存限制，可在 docker-compose.yml 中添加配置

4. 安全建议：

   • 生产环境建议使用 HTTPS
   • 可以配置反向代理（如 Nginx）
   • 定期更新基础镜像和依赖