mirror of
https://github.com/remvze/moodist.git
synced 2025-12-17 08:54:13 +00:00
68 lines
2.5 KiB
Markdown
68 lines
2.5 KiB
Markdown
<div align="center">
|
|
<img src="/assets/banner.svg" alt="Moodist Logo Banner" />
|
|
<h2>Moodist 🌲</h2>
|
|
<p>Ambient sounds for focus and calm.</p>
|
|
<a href="https://moodist.app">Visit <strong>Moodist</strong></a> | <a href="https://buymeacoffee.com/remvze">Buy Me a Coffee</a>
|
|
</div>
|
|
|
|
## Features
|
|
|
|
- 🎵 Over 75 ambient sounds
|
|
- 📝 Persistent sound selection
|
|
- ✈️ Sharing sound selections with others
|
|
- 🧰 Custom sound presets
|
|
- 🌙 Sleep timer for sounds (soon)
|
|
- 📓 Notepad for quick notes
|
|
- ⌛ Pomodoro timer
|
|
- ✅ Simple to-do list (soon)
|
|
- ⌨️ 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
|
|
- ⚙️ **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 varsion
|
|
- `npm run release:minor`: release minor varsion
|
|
- `npm run release:patch`: release patch varsion
|
|
- `npm run storybook`: run Storybook
|
|
|
|
## 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**: [Link to Pixabay Content License](https://pixabay.com/service/license-summary/)
|
|
- Sounds licensed under **CC0**: [Creative Commons Zero License](https://creativecommons.org/publicdomain/zero/1.0/)
|