mirror of
https://github.com/remvze/moodist.git
synced 2025-09-29 15:30:49 -04:00
89 lines
3.0 KiB
Markdown
89 lines
3.0 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>
|
|
|
|
## 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. ⌨️ 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/)
|