Awesome
<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>Table of Contents
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).
- โจ๏ธ 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 servernpm run build
: build for productionnpm run preview
: preview the built appnpm run lint
: lint files using ESLintnpm run lint:fix
: lint and fix using ESLintnpm run lint:style
: lint styles using Stylelintnpm run lint:style:fix
: lint and fix styles using Stylelintnpm run format
: format files using Prettiernpm run commit
: commit message using Commitizennpm run release:major
: release major versionnpm run release:minor
: release minor versionnpm run release:patch
: release patch versionnpm 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