Skip to content

Latest commit

 

History

History
179 lines (138 loc) · 6.51 KB

README.md

File metadata and controls

179 lines (138 loc) · 6.51 KB
Raw


Aonsoku

Aonsoku

A modern desktop client for Navidrome/Subsonic servers built with React and Rust.

Web App · Report Bug · Request Feature

React Tauri Rust

Table of Contents
  1. Features
  2. Screenshots
  3. Getting Started
  4. Roadmap
  5. Contributing
  6. License

Features

  • Subsonic Integration: Aonsoku integrates with your Navidrome or Subsonic server, providing you with easy access to your music collection.
  • Intuitive UI: Modern, clean and user-friendly interface designed to enhance your music listening experience.
  • Unsynchronized lyrics: If your songs have embedded unsynchronized lyrics, Aonsoku is able to show them on full screen mode.
  • Radio: If your server supports it, listen to radio shows directly within Aonsoku.
  • Scrobble: Sync played songs with your server.

(back to top)

Screenshots

(back to top)

Getting Started

As Aonsoku is currently in early development, to use the desktop app you need to build it yourself.

Prerequisites

  • Node.js
  • pnpm, npm or yarn
  • Rust
  • cargo

Installation

  1. Clone the repo
git clone https://github.com/victoralvesf/aonsoku.git
  1. Install NPM packages
pnpm install
  1. Install tauri-cli
cargo install tauri-cli

Running

  • Web App
pnpm run dev
  • Desktop App
pnpm run tauri dev
  • Docker
version: '3.8'

services:
  aonsoku:
    container_name: aonsoku
    image: ghcr.io/victoralvesf/aonsoku:latest
    restart: unless-stopped
    ports:
      - 8080:8080
    environment:
      - SERVER_URL=http://address:port
      - HIDE_SERVER=true # When it's true AND SERVER_URL is set, only username and password will be visible on login.

Recommended IDE Setup

(back to top)

Roadmap

  • Downloads:
    • Playlist
    • Album
    • Artist
    • Song
  • Queue page
  • Playlist editor
  • Synced lyrics
  • Podcast support

Feel free to request more cool features here.

(back to top)

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)