This commit is contained in:
2025-12-09 16:33:44 +08:00
parent 345af5e2a3
commit 1d42f5ea50
49 changed files with 12015 additions and 1 deletions

231
快速开始.md Executable file
View File

@@ -0,0 +1,231 @@
# 🚀 快速开始 - 3分钟部署指南
## 📦 准备工作
### 1. 确认 Go 已安装
打开终端,输入:
```bash
go version
```
✅ 看到版本号(如 `go version go1.21.x`- 已安装,继续下一步
❌ 提示未找到命令 - 需要先安装Go
**安装 Go**
- Windows: https://golang.org/dl/ (下载安装包)
- macOS: `brew install go`
- Linux: `sudo apt install golang-go`
---
## 🎯 三步部署
### Windows 用户
#### 第一步:打开项目目录
```bash
cd d:\esp32-music-server\Meow\MeowEmbeddedMusicServer
```
#### 第二步:双击启动
找到 `start.bat` 文件,双击运行
#### 第三步:访问应用
浏览器打开http://localhost:2233/app
**就这么简单!** 🎉
---
### Linux / macOS 用户
#### 第一步:进入项目目录
```bash
cd /path/to/MeowEmbeddedMusicServer
```
#### 第二步:添加执行权限并启动
```bash
chmod +x start.sh
./start.sh
```
#### 第三步:访问应用
浏览器打开http://localhost:2233/app
**完成!** 🎉
---
## 🎵 首次使用
1. **注册账户**
- 访问 http://localhost:2233/app
- 点击右侧"注册"标签
- 填写:用户名、邮箱、密码
- 点击"注册"按钮
2. **搜索音乐**
- 登录后,在搜索框输入歌曲名
- 例如:"告白气球"
- 点击"搜索"
3. **播放音乐**
- 搜索结果出现后
- 点击"▶ 播放"按钮
4. **添加收藏**
- 在搜索结果页
- 使用下拉菜单选择"我喜欢"
- 歌曲自动添加到收藏
5. **创建歌单**
- 左侧边栏"我的歌单"旁
- 点击"+"号
- 输入歌单名称
- 确认创建
---
## 🔧 常见问题
### Q: 端口被占用怎么办?
**Windows:**
```bash
netstat -ano | findstr :2233
taskkill /PID <进程ID> /F
```
**Linux/macOS:**
```bash
lsof -i :2233
kill -9 <PID>
```
或修改端口:编辑 `.env` 文件,将 `PORT=2233` 改为 `PORT=3000`
---
### Q: 依赖下载失败?
**中国大陆用户**需要配置Go代理
```bash
go env -w GOPROXY=https://goproxy.cn,direct
```
然后重新运行启动脚本
---
### Q: 如何停止服务器?
在启动的终端窗口中按 `Ctrl + C`
---
### Q: 如何让局域网其他设备访问?
1. 找到本机IPWindows: `ipconfig`Linux/Mac: `ifconfig`
2. 修改 `.env` 文件:
```env
WEBSITE_URL=http://你的IP:2233
```
3. 重启服务器
4. 其他设备访问:`http://你的IP:2233/app`
---
## 📚 更多文档
- **详细部署指南**: 查看 `本地部署指南.md`
- **API文档**: 查看 `USER_SYSTEM_README.md`
- **功能说明**: 查看 `新功能说明.md`
---
## 💡 使用技巧
### 快捷键
- 搜索框按 `Enter` 键可以快速搜索
- `Ctrl + C` 停止服务器
### 推荐浏览器
- Chrome / Edge
- Firefox
- Safari
### 数据备份
定期备份 `files/` 目录,保存用户数据和歌单
---
## 🎯 目录结构
```
MeowEmbeddedMusicServer/
├── start.bat ← Windows启动双击
├── start.sh ← Linux/Mac启动
├── .env ← 配置文件(可选)
├── theme/
│ └── music-app.html ← 新版界面
└── files/ ← 数据存储(自动创建)
├── users.json ← 用户数据
└── user_playlists.json ← 歌单数据
```
---
## ✅ 快速检查清单
部署前:
- [ ] Go 已安装1.19+
- [ ] 项目已下载到本地
- [ ] 端口 2233 未被占用
部署后:
- [ ] 启动脚本运行成功
- [ ] 浏览器可以打开 http://localhost:2233/app
- [ ] 可以注册新账户
- [ ] 可以搜索音乐
全部打勾 = 部署成功!🎉
---
## 🆘 需要帮助?
### 查看日志
启动后的终端窗口会显示所有日志信息
### 社区支持
- QQ群865754861喵波音律-音乐家园)
- 查看详细文档:`本地部署指南.md`
### 重新开始
如果遇到问题,可以:
1. 关闭服务器Ctrl+C
2. 删除 `files/` 目录
3. 重新运行启动脚本
---
## 🎉 恭喜!
你现在拥有一个属于自己的音乐服务器了!
**开始享受音乐吧!** 🎵✨
```
╔═══════════════════════════════════╗
║ 新版应用地址 ║
║ http://localhost:2233/app ║
╚═══════════════════════════════════╝
```
**下一步:**
1. 🎵 搜索你喜欢的音乐
2. ❤️ 创建你的收藏歌单
3. 📱 让朋友也来试试(局域网访问)