https://github.com/ricopella/cratecleaner
Make your library clutter-free! This Electron app cleans up your digital music and image collections. Unique for DJs: identifies which songs are in crates while detecting duplicates. Digs into metadata for smart cleanup.
https://github.com/ricopella/cratecleaner
audio dedupe-library duplicate-detection duplicatefilefinder electron image prisma react serato tailwind tanstack-react-query typescript vite zod
Last synced: 4 months ago
JSON representation
Make your library clutter-free! This Electron app cleans up your digital music and image collections. Unique for DJs: identifies which songs are in crates while detecting duplicates. Digs into metadata for smart cleanup.
- Host: GitHub
- URL: https://github.com/ricopella/cratecleaner
- Owner: ricopella
- Created: 2023-09-26T16:24:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-08T08:29:30.000Z (over 2 years ago)
- Last Synced: 2025-03-25T14:44:44.450Z (11 months ago)
- Topics: audio, dedupe-library, duplicate-detection, duplicatefilefinder, electron, image, prisma, react, serato, tailwind, tanstack-react-query, typescript, vite, zod
- Language: TypeScript
- Homepage:
- Size: 11.1 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ๐ต๐งน Crate Cleaner ๐งน๐ต
The ultimate tool for DJs and music enthusiasts! This Electron-based application is designed with a sleek UI (resembling Serato DJs interface) and is powered by a robust tech stack including React, TypeScript, Vite, Prisma, SQLite, and Tailwind CSS. Perfect for tidying up your audio collection, Crate Cleaner is a must-have in your digital DJ toolbox.
## โจ Features
Crate Cleaner is not just another file manager; it's tailored for DJ's specific needs. Here's what it can do for you:
- ๐ถ Scan and identify duplicate audio and image files.
- ๐ Compare files by name or content to find matches.
- ๐ฆ Detect audio files that are not in use in Serato crates.
- ๐พ Persist and manage data with an integrated SQLite database.
- ๐ Organize crates by adding or removing files.
## ๐ Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Make sure you have [Node.js](https://nodejs.org/) (>= v18 or greater) and [Yarn](https://yarnpkg.com/) installed on your system.
### Install
Clone the repository and install its dependencies.
```bash
git clone https://github.com/yourusername/crate-cleaner.git
cd crate-cleaner
yarn install
```
Before kicking off the development server, let's set up the development database and run the migrations so it matches the schema:
```bash
yarn predev
```
Now, you're all set to start the dev server:
```bash
yarn dev
```
### Build
To build the application for production, use the appropriate command based on your operating system:
```bash
# For Windows
$ yarn build:win
# For macOS
$ yarn build:mac
# For Linux
$ yarn build:linux
```
### ๐ Tech Stack
Crate Cleaner leverages a robust set of technologies to deliver a seamless experience. Check out more about each component:
- [Electron](https://www.electronjs.org/)
- [React](https://reactjs.org/)
- [Node.js](https://nodejs.org/)
- [Vite](https://vitejs.dev/)
- [Prisma](https://www.prisma.io/)
- [SQLite](https://www.sqlite.org/index.html)
- [Tailwind CSS](https://tailwindcss.com/)
- [DaisyUI](https://daisyui.com/)
- [Tanstack/react-query](https://react-query.tanstack.com/)
- [Tanstack/react-table](https://tanstack.com/table/v8)
- [Zod](https://github.com/colinhacks/zod)
- [TypeScript](https://www.typescriptlang.org/)
### ๐ Upcoming Features
We are always looking to make Crate Cleaner even better. Here's what's on the horizon:
Support for RekordBox, Traktor, Apple Music, and Lightroom.
Enhanced file management options, such as moving duplicates rather than deleting.
Introduction of an audio player and fuzzy name match capabilities.
And much more!
### ๐ค Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
### โ Buy Me a Coffee
Love Crate Cleaner? Want to support the caffeine-fueled late nights that went into building this tool? Buy me a coffee and fuel further development!
[](https://www.buymeacoffee.com/narinsun)
### ๐ฌ Contact
Got questions, feedback, or want to say hi? I'm just a click away over at [narinsun.com](https://narinsun.com).
## ๐ License
Crate Cleaner is made available under the [Attribution-NonCommercial 4.0 International](http://creativecommons.org/licenses/by-nc/4.0/?ref=chooser-v1) license. This means that you are free to share and adapt the material as long as you follow the license terms which include:
- **Attribution** โ You must give appropriate credit to [Narin Rico Sundarabhaya](https://narinsun.com), provide a link to the license, and indicate if changes were made.
- **NonCommercial** โ You may not use the material for commercial purposes.
For more information, please see the full license [here](http://creativecommons.org/licenses/by-nc/4.0/?ref=chooser-v1).

This license is applicable for free use of Crate Cleaner but does not allow for commercial use without proper attribution and without express permission from the creator.