moodist/README.zh-CN.md at a76585c61a2b53e44f450f7b9e9626ef0dfdbef4

mirror of https://github.com/remvze/moodist.git synced 2025-12-19 09:54:17 +00:00

zl a8718df8d2 feat: add comprehensive Docker deployment support and Chinese documentation

- Add Docker deployment configuration with multiple Dockerfile variants
- Implement simplified Docker build scripts for better compatibility
- Update docker-compose configurations to use walllee/moodist image
- Create comprehensive Docker deployment documentation
- Add Chinese README (README.zh-CN.md) with full translation
- Implement language selection links in both README files
- Add quick start guide and Docker deployment instructions in Chinese
- Include Docker build and push commands in package.json scripts

New files added:
- Docker configurations (Dockerfile.* variants)
- Docker Compose files (dev, optimized versions)
- Build scripts (scripts/*.sh)
- Docker deployment documentation (DOCKER_DEPLOY.md)
- Chinese README with complete translation

2025-11-16 15:35:01 +08:00

4.2 KiB

Raw Blame History

🌍 Language / 语言

English | 简体中文

Moodist 🌲

环境音生成器 - 专注与平静的声音伴侣。

访问 Moodist | 请我喝杯咖啡

功能特性

🎵 超过 75 种环境音
📝 持久化的声音选择
✈️ 与他人分享声音选择
🧰 自定义声音预设
🌙 睡眠定时器
📓 快速记事本
🍅 番茄钟计时器
✅ 简单的待办事项列表（即将推出）
⏯️ 媒体控制
⌨️ 全功能键盘快捷键
🥷 注重隐私：不收集任何数据
💰 完全免费、开源、可自托管

🚀 快速开始

本地开发

# 克隆项目
git clone https://github.com/wheesys/moodist.git
cd moodist

# 安装依赖
npm install

# 启动开发服务器
npm run dev

访问 http://localhost:4321 查看应用。

构建生产版本

# 构建应用
npm run build

# 预览构建结果
npm run preview

🐳 Docker 部署

直接运行

# 拉取镜像
docker pull walllee/moodist:latest

# 运行容器
docker run -d \
  --name moodist \
  -p 8080:8080 \
  --restart unless-stopped \
  walllee/moodist:latest

使用 Docker Compose

# 简单版本
docker-compose up -d

# 或使用优化版本
docker-compose -f docker-compose.optimized.yml up -d

访问 http://localhost:8080 查看应用。

自定义构建

# 构建镜像
npm run docker:push

# 带版本号构建
./scripts/build-docker-simple.sh 2.1.0

# 构建并推送到 Docker Hub
npm run docker:push-and-upload

📖 详细部署指南请查看 DOCKER_DEPLOY.md

技术工具

⚡ TypeScript: 编程语言
🔨 React: UI 库
🧑‍🚀 Astro: 元框架
🎨 CSS Modules: 样式方案
🐻 Zustand: 状态管理
🎭 Framer Motion: 动画库
⚙️ Radix: 无障碍组件
📕 Storybook: 组件文档
🧪 Vitest: 单元测试（即将推出）
🔭 Playwright: 端到端测试（即将推出）
🔍 ESLint: 代码检查
🧹 Prettier: 代码格式化
🧼 Stylelint: CSS 检查
🐶 Husky: Git 钩子
📝 Lint Staged: 暂存文件检查器
🧽 Commitlint: Git 提交信息检查
🧭 Commitizen: Git 提交信息助手
📓 Standard Version: 版本管理和更新日志生成
🧰 PostCSS: CSS 转换

命令说明

npm run dev: 运行开发服务器
npm run build: 构建生产版本
npm run preview: 预览构建的应用
npm run lint: 使用 ESLint 检查代码
npm run lint:fix: 使用 ESLint 检查并修复代码
npm run lint:style: 使用 Stylelint 检查样式
npm run lint:style:fix: 使用 Stylelint 检查并修复样式
npm run format: 使用 Prettier 格式化文件
npm run commit: 使用 Commitizen 提交代码
npm run release:major: 发布主版本
npm run release:minor: 发布次版本
npm run release:patch: 发布补丁版本
npm run storybook: 运行 Storybook

贡献指南

🚧 请查看 CONTRIBUTING.md 文件。

支持 Moodist

⭐ 如果您喜欢这个项目，请给它一个星标。

☕ 请我喝杯咖啡来帮助我维护 Moodist。

许可证

本项目基于 MIT 许可证 - 详情请查看 LICENSE 文件。

⚠️ 第三方资源

本项目使用的部分声音来源于第三方提供商，并遵循不同的许可证：

遵循 Pixabay 内容许可证 的声音：Pixabay 内容许可证
遵循 CC0 的声音：知识共享署名许可协议

4.2 KiB Raw Blame History Unescape Escape