Skip to content

Latest commit

 

History

History
99 lines (67 loc) · 1.94 KB

README.md

File metadata and controls

99 lines (67 loc) · 1.94 KB
Raw

Dester Desktop Client

Dester Desktop Client is an open-source Electron-based media organizer that helps you manage, categorize, and explore your media files effortlessly. Built and maintained under the DesterLib GitHub organization, this project aims to offer a seamless experience for organizing media libraries.

Features

  • Organize media files into customizable categories.
  • Metadata fetching for movies, TV shows, and more.
  • Easy-to-use, intuitive UI for media management.
  • Cross-platform support (Windows, macOS, Linux).
  • Completely Open-source.

Getting Started

To get started with Dester Desktop Client, follow these steps:

Installation

  1. Clone the repository:

    git clone https://github.com/DesterLib/Desktop.git

  2. Install dependencies:

    pnpm install

  3. Run the app in development mode:

    pnpm dev

  4. To build the app:

    pnpm build

  5. To start the app in preview mode (after building):

    pnpm start

  6. Run Storybook for component documentation:

    pnpm storybook

  7. To build Storybook:

    pnpm build-storybook

  8. To lint and format code:

    pnpm lint
pnpm format

  9. To check types:

    pnpm typecheck

  10. To build for specific platforms:

  • Windows: 
    pnpm build:win
  • macOS: 
    pnpm build:mac
  • Linux: 
    pnpm build:linux

Contributing

We welcome contributions of all kinds! Whether you're fixing a bug, adding a new feature, or improving documentation, check out our Contributing Guide for details on how to get involved.

License

This project is licensed under the GNU Affero General Public License (AGPL).

Contact

For any questions or feedback, feel free to open an issue or reach out through the GitHub repository. Join us in making Dester Desktop Client better!