1
0
Fork 0
mirror of https://github.com/heyarne/airsonic-ui.git synced 2026-05-07 02:33:39 +02:00
Modern user interface for https://github.com/airsonic/airsonic – CURRENTLY INACTIVE
  • Clojure 96.1%
  • Sass 2.8%
  • JavaScript 0.7%
  • HTML 0.4%
Find a file
2019-12-08 00:52:13 +01:00
.circleci Ignore gh-pages for builds on circle-ci 2019-04-01 18:16:58 +02:00
docs Improve docs and simplify dev script 2018-08-22 12:33:38 +02:00
src Move artist overview into library; closes #50 and #52 2019-12-08 00:52:13 +01:00
test/cljs Use more sensible naming for api responses 2019-12-07 22:17:56 +01:00
.gitignore Restructure app init; fixes #5 and #11 2018-07-09 21:16:28 +02:00
.joker Add a real playlist (#20) 2018-08-20 16:34:52 +02:00
.travis.yml Revert "Configure travis to test and build in parallel" 2018-11-09 17:56:29 +01:00
karma.conf.js Improvements to currently playing queue (#48) 2019-03-12 15:22:13 +01:00
LICENSE.txt Add license 2018-11-26 09:13:15 +01:00
package-lock.json Make the logo clickable #51 (#62) 2019-10-01 12:06:19 +02:00
package.json Fix sass live-reload 2019-12-08 00:52:13 +01:00
postcss.config.js Improvements to currently playing queue (#48) 2019-03-12 15:22:13 +01:00
README.md Update dependencies to enable Greenkeeper 🌴 (#53) 2019-07-16 10:33:51 +02:00
shadow-cljs.edn Move editor config out of shadow-cljs.edn 2019-12-08 00:52:13 +01:00

Airsonic Web Client Build Status CircleCI Greenkeeper badge

This repository contains an alternative web frontend for airsonic. The goal is to eventually be able to fully replace the current web interface.

Implemented so far

  • Login with persisting credentials
  • Browse your library by newest / most recently played / starred
  • Browse artists alphabetically
  • A currently playing queue with next, previous, repeat and shuffle
  • Information about the current track with the ability to seek

Development

The project is written in ClojureScript and uses re-frame for structure and peace of mind. The build tool is shadow-cljs, which offers nice editor integration and interoparibility with the whole JavaScript ecosystem. If you haven't worked with re-frame: I highly recommend it. Good resources are the project's docs and a post about its building blocks.

To build the project make sure you have Node.js (v6.0.0), npm and Java 8 installed in your system.

# after cloning the project, first install all dependencies
$ npm install

# start a continuous build with hot-code-reloading and continuous testing
# first build takes a while. open http://localhost:8080
$ npm run dev

Editor integration

Integrating shadow-cljs with your editor helps tremendously with development. After having run npm run dev as described above you can connect to the REPL and get features like in-editor code execution and code completion / documentation lookup. For further information see this part of the shadow-cljs user guide, which contains instructions for Emacs, Atom, VSCode and other editors. Make sure to open localhost:8080 in the browser to execute ClojureScript code.

re-frame-10x

re-frame-10x is a debugger that is bundled with the app in development mode. Once you have the build running, hit Ctrl + h and the re-frame-10x window will show up:

re-frame-10x in action

It provides you with tools to inspect the state of the application, undo and replay events, debug performance issues and more.

Tests

This project uses karma for tests. Make sure to have Google Chrome installed, otherwise the watcher will time out.

# run tests once
$ npm test

Note: If you want nice console output in your tests, make sure to (enable-console-print!). You can call println afterwards like you're used to.

Deployment

# build and optimize the code once for production
$ npm run build

# runs npm run build and publishes everything via gh-pages
$ npm run deploy

Note: If you have a continuous build running and run npm run build or npm run deploy, it will delete the compiled tests, causing the continuous tests to not run anymore. This can be fixed by running npm test again.

All build artifacts land in /public. Don't change anything in there as changes will be overwritten.