mirror of
https://github.com/remvze/moodist.git
synced 2025-12-19 18:04:13 +00:00
b973c7bf61
## 主要功能更新 ### 🎨 优化昼夜模式主题系统 - 参考现代设计标准（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 - 新增功能：昼夜主题、智能随机、完整文档 - 向后兼容：完全兼容现有配置和数据
95 lines
No EOL
3.1 KiB
Markdown
95 lines
No EOL
3.1 KiB
Markdown
## 🌍 Language / 语言
|
|
|
|
**[English](README.en.md)** | **[简体中文](README.md)**
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
<img src="/assets/banner.png" alt="Moodist Logo Banner" />
|
|
<h2>Moodist 🌲</h2>
|
|
<p>Ambient sounds for focus and calm.</p>
|
|
<a href="https://moodist.mvze.net">Visit <strong>Moodist</strong></a> | <a href="https://buymeacoffee.com/remvze">Buy Me a Coffee</a>
|
|
</div>
|
|
|
|
## Table of Contents
|
|
|
|
- ⚡ [Features](#features)
|
|
- 🧰 [Tools](#tools)
|
|
- 🔮 [Commands](#commands)
|
|
- 🚧 [Contributing](#contributing)
|
|
- ⭐ [Support](#support-moodist)
|
|
- 📜 [License](#license)
|
|
|
|
## Features
|
|
|
|
1. 🎵 Over 75 ambient sounds.
|
|
1. 📝 Persistent sound selection.
|
|
1. ✈️ Sharing sound selections with others.
|
|
1. 🧰 Custom sound presets.
|
|
1. 🌙 Sleep timer for sounds.
|
|
1. 📓 Notepad for quick notes.
|
|
1. 🍅 Pomodoro timer.
|
|
1. ✅ Simple to-do list (soon).
|
|
1. ⏯️ Media controls.
|
|
1. ⌨️ Keyboard shortcuts for everything.
|
|
1. 🥷 Privacy focused: no data collection.
|
|
1. 💰 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](CONTRIBUTING.md) file.
|
|
|
|
## Support Moodist
|
|
|
|
⭐ Give a star if you liked this project.
|
|
|
|
☕ [Buy Me a Coffee](https://buymeacoffee.com/remvze) to help me maintain Moodist.
|
|
|
|
## License
|
|
|
|
This project is licensed under the **MIT License** - see the [LICENSE](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](https://pixabay.com/service/license-summary/)
|
|
- Sounds licensed under **CC0**: [Creative Commons Zero License](https://creativecommons.org/publicdomain/zero/1.0/) |