Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 2.99 KB

README.md

File metadata and controls

88 lines (70 loc) · 2.99 KB
Moodist Logo Banner

Moodist 🌲

Ambient sounds for focus and calm.

Visit Moodist | Buy Me a Coffee

Table of Contents

Features

  1. 🎵 Over 75 ambient sounds
  2. 📝 Persistent sound selection
  3. ✈️ Sharing sound selections with others
  4. 🧰 Custom sound presets
  5. 🌙 Sleep timer for sounds
  6. 📓 Notepad for quick notes
  7. 🍅 Pomodoro timer
  8. ✅ Simple to-do list (soon)
  9. ⌨️ Keyboard shortcuts for everything
  10. 🥷 Privacy focused: no data collection
  11. 💰 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: