Features
- Playlists & folders
- Filtering
- Queue
- Metadata editing
- Fast. Navigation, sorting & filtering should be instant even for libraries with 100 000 tracks
- Quick playlist navigation with CmdK or CtrlK
Dev instructions
Get started
- Install Node.js
- Install Rust
- Run
npm install
Structure
App (Electron)
- Source:
src/electron.js
and src/electron/
- Build output:
build/app/
Web (the frontend)
- Source code: napi and
src/
- Build output:
build/web/
Napi (the native Rust backend)
- Source code:
src-native/
- Build output:
ferrum-addon/addon.node
Commands
-
npm run dev
: Start app in dev mode
-
npm run dev-release
: Start app in dev mode (optimized)
-
npm run build
: Build
-
npm run lint
: Lint
-
npm run format
: Format
Publish new version
- Run
npm run check
- Update
CHANGELOG.md
- Run
npm version --no-git-tag <version>
to bump the version number
- Create a git tag in the format
v#.#.#
- Add release notes to the generated GitHub release and publish it