Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Isaac-Bao committed Jan 12, 2025
1 parent ae1c4dd commit 5b6eef9
Showing 1 changed file with 88 additions and 20 deletions.
108 changes: 88 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# 局域网聊天室

这是一个基于 WebSocket 的局域网即时聊天应用,支持多用户实时聊天和用户名设置。
`100%仅依靠cline + deepseek-API`
这是一个基于 WebSocket 的局域网即时聊天应用,支持多用户实时聊天和用户名设置。 100%仅依靠 cline + deepseek-API

## 功能特性

Expand All @@ -14,33 +13,101 @@
## 技术栈

- Node.js (Express + WebSocket)
- MongoDB (消息存储)
- HTML5 + CSS3
- JavaScript (ES6)

## How to use
## 环境要求

1. Node.js (v18+)
2. MongoDB (v6+)

## 安装指南

### 1. 安装和启动 MongoDB

- macOS:

```bash
# 安装MongoDB
brew tap mongodb/brew
brew install mongodb-community@6.0

# 启动MongoDB服务
brew services start mongodb-community

# 检查服务状态
brew services list

# 如果服务未运行,手动启动
mongod --config /usr/local/etc/mongod.conf
```

- Windows:

> 注意,win 的配置我自己也不是很清楚,推荐使用 mac 来运行本项目
1. 下载安装包:https://www.mongodb.com/try/download/community
2. 按照安装向导完成安装
3. 启动 MongoDB 服务:
- 打开命令提示符(管理员权限)
- 运行以下命令:
```bash
net start MongoDB
```
- 检查服务状态:
```bash
sc query MongoDB
```
- 如果服务未运行,手动启动:
```bash
"C:\Program Files\MongoDB\Server\6.0\bin\mongod.exe" --config "C:\Program Files\MongoDB\Server\6.0\bin\mongod.cfg"
```

- 常见问题:
- 如果端口 27017 被占用:
```bash
sudo lsof -i :27017 # 查看占用进程
sudo kill <PID> # 终止占用进程
```
- 如果权限不足:
```bash
sudo chown -R `whoami` /data/db # macOS/Linux
```

### 2. 克隆仓库

```bash
git clone https://github.com/Ganzhe2028/LAN-ChatRoom.git
cd LAN-ChatRoom
```

### 3. 安装依赖

1. 克隆仓库:
```bash
npm install
```

```bash
git clone https://github.com/Ganzhe2028/LAN-ChatRoom.git
```
### 4. 启动服务器

2. 安装依赖:
```bash
npm start
```

```bash
npm install
```
### 5. 访问应用

3. 启动服务器:
在浏览器中访问:

```
http://localhost:8081
```
```bash
npm start
```
## 数据库配置
4. 在浏览器中访问:
```
http://localhost:3000
```
- 默认使用本地 MongoDB 实例 (mongodb://localhost:27017)
- 数据库名称:chatApp
- 集合名称:messages
- 如果需要修改配置,请编辑 server.js 中的相关参数
## 使用说明
Expand All @@ -52,8 +119,9 @@
## 注意事项
- 确保所有用户在同一个局域网内
- 默认端口为 3000,可在 server.js 中修改
- 默认端口为 8081,可在 server.js 中修改
- 建议使用现代浏览器以获得最佳体验
- 确保 MongoDB 服务已启动
## 项目结构
Expand Down

0 comments on commit 5b6eef9

Please sign in to comment.