mirror of
https://github.com/heyarne/airsonic-ui.git
synced 2026-05-06 18:33:38 +02:00
heyarne
6e17c254c7* Add build step to circleci config * Add deploy job to circleci * Configure test → build → deploy as a cascade and ensure `public` exists when building * Add deploy key * Deploy only on master * Remove ssh keys from build step * Remove travis-ci * Move build-report into task and update README.md
79 lines
4.2 KiB
Markdown
79 lines
4.2 KiB
Markdown
# Airsonic Web Client [](https://circleci.com/gh/heyarne/airsonic-ui) [](https://greenkeeper.io/)
|
|
|
|
This repository contains an alternative web frontend for [airsonic](https://github.com/airsonic/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
|
|
|
|
## How Do I Host This Myself?
|
|
|
|
There are two options:
|
|
|
|
- You build it yourself by cloning the repository and running `npm run build`
|
|
- You grab a pre-built version from the [gh-pages branch](https://github.com/heyarne/airsonic-ui/tree/gh-pages) (just click the download button)
|
|
|
|
The files you receive either way should be identical. There's [an article about setting up nginx](https://github.com/heyarne/airsonic-ui/wiki/Self%E2%80%93hosting) in the repository wiki.
|
|
|
|
If you have any questions please ask them in the [airsonic matrix channel](https://riot.im/app/#/room/#airsonic:matrix.org).
|
|
|
|
## Development
|
|
|
|
The project is written in [ClojureScript](https://clojurescript.org/) and uses [re-frame](https://github.com/Day8/re-frame) for structure and peace of mind. The build tool is [shadow-cljs](https://shadow-cljs.github.io/docs/UsersGuide.html), 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](https://github.com/Day8/re-frame/tree/master/docs) and a [post about its building blocks](https://purelyfunctional.tv/guide/re-frame-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
|
|
```
|
|
|
|
All other build tasks are defined in the `package.json` (more below).
|
|
|
|
### 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](https://shadow-cljs.github.io/docs/UsersGuide.html#_editor_integration). Recommended editors and plugins are Calva for VSCode and CIDER for Emacs (comes with Spacemacs). Make sure to open `localhost:8080` in the browser after starting the `dev:cljs` task to execute ClojureScript code in a live REPL.
|
|
|
|
### 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:
|
|
|
|
|
|
|
|
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](https://karma-runner.github.io/) 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
|
|
|
|
# publishes everything via gh-pages
|
|
$ npm run deploy
|
|
```
|
|
|
|
There is continuous deployment set up on [circleci](https://circleci.com/gh/heyarne/airsonic-ui) that builds and deploys to `gh-pages` after a commit to the `master` branch.
|
|
|
|
**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.
|