moodist/README.en.md at aefa28ea9928373d5b9828ce64fb92f5cefba83d

mirror of https://github.com/remvze/moodist.git synced 2025-12-18 17:34:17 +00:00

zl b973c7bf61 feat: 实现完整的昼夜主题系统和优化随机音频功能

## 主要功能更新

### 🎨 优化昼夜模式主题系统
- 参考现代设计标准（GitHub、VSCode）重新设计颜色方案
- 明亮主题：纯白背景 + 深灰文字，提供高对比度阅读体验
- 暗色主题：深蓝灰背景 + 高亮白色，护眼且现代
- 全面适配：所有组件背景色、边框色、前景色都跟随主题切换

### 🎲 改进随机音频功能
- 智能单参数随机：每次只随机调整一个参数（速度/音调/音量）
- 合理变化频率：调整为60-90秒，避免频繁变化影响体验
- 精确范围控制：
  - 速度和音调：默认值 ±0.25 范围内随机
  - 音量：30%-70% 范围内随机

### 📚 完善文档系统
- 创建英文版 README (README.en.md)
- 完善中文版 README，包含：
  - 详细的使用说明和操作指南
  - 完整的 Docker 部署教程
  - 生产环境配置指南
  - 在线体验地址：https://calm.zlext.com

### 🔧 技术改进
- 新增完整的主题切换组件 (ThemeToggle)
- 优化随机音频控制组件 (RandomSpeed)
- 改进声音控制组件的样式和交互
- 更新所有组件样式以支持主题变量

## 版本信息
- 版本升级：v2.1.0 → v2.2.0
- 新增功能：昼夜主题、智能随机、完整文档
- 向后兼容：完全兼容现有配置和数据

2025-11-17 11:03:14 +08:00

3.1 KiB

Raw Blame History

🌍 Language / 语言

English | 简体中文

Moodist 🌲

Ambient sounds for focus and calm.

Visit Moodist | Buy Me a Coffee

⚡ Features
🧰 Tools
🔮 Commands
🚧 Contributing
⭐ Support
📜 License

Features

🎵 Over 75 ambient sounds.
📝 Persistent sound selection.
✈️ Sharing sound selections with others.
🧰 Custom sound presets.
🌙 Sleep timer for sounds.
📓 Notepad for quick notes.
🍅 Pomodoro timer.
✅ Simple to-do list (soon).
⏯️ Media controls.
⌨️ Keyboard shortcuts for everything.
🥷 Privacy focused: no data collection.
💰 Completely free, open-source, and self-hostable.

Tools

⚡ TypeScript: Programming Language
🔨 React: UI Library
🧑‍🚀 Astro: Meta Framework
🎨 CSS Modules: Styling
🐻 Zustand: State Management
🎭 Framer Motion: Animation Library
⚙️ Radix: Accessible Components
📕 Storybook: Component Documentation
🧪 Vitest: Unit Testing (soon)
🔭 Playwright: End-To-End Testing (soon)
🔍 ESLint: Code Linting
🧹 Prettier: Code Formatting
🧼 Stylelint: CSS Linting
🐶 Husky: Git Hooks
📝 Lint Staged: Running Linters on Staged Files
🧽 Commitlint: Git Commit Linting
🧭 Commitizen: Git Commit Message Helper
📓 Standard Version: Versioning and CHANGLOG Generation
🧰 PostCSS: CSS Transformations

Commands

npm run dev: run development server
npm run build: build for production
npm run preview: preview the built app
npm run lint: lint files using ESLint
npm run lint:fix: lint and fix using ESLint
npm run lint:style: lint styles using Stylelint
npm run lint:style:fix: lint and fix styles using Stylelint
npm run format: format files using Prettier
npm run commit: commit message using Commitizen
npm run release:major: release major version
npm run release:minor: release minor version
npm run release:patch: release patch version
npm run storybook: run Storybook

Contributing

🚧 Please check CONTRIBUTING.md file.

Support Moodist

⭐ Give a star if you liked this project.

☕ Buy Me a Coffee to help me maintain Moodist.

License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Third-Party Assets

Some sounds used in this project are sourced from third-party providers and are subject to different licenses:

Sounds licensed under the Pixabay Content License: Pixabay Content License
Sounds licensed under CC0: Creative Commons Zero License

3.1 KiB Raw Blame History