koel/README.md
2016-03-20 22:37:13 +08:00

21 lines
1.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# koel
![Showcase](http://koel.phanan.net/dist/img/showcase.png?2)
## Supporting Vue.js
Koel is built on [Vue.js](http://vuejs.org/), the ongoing development of which is made possible thanks to the support by these awesome [backers](https://github.com/vuejs/vue/blob/dev/backers.md). If you'd like to join them, check out [Vue.js' Patreon campaign](https://www.patreon.com/evanyou).
## Intro
**Koel** (also styled as **koel**, with a lowercase k) is a simple web-based personal audio streaming service written in [Vue](http://vuejs.org/) at the client side and [Laravel](http://laravel.com/) on server side. Targeting web developers, Koel embraces some of the more modern web technologies flexbox, audio, and drag-and-drop API to name a few to do its job.
## Install and Upgrade Guide
For system requirements, installation guides, and troubleshooting, head over to [Wiki](https://github.com/phanan/koel/wiki).
If you are upgrading, see [Releases](https://github.com/phanan/koel/releases) for guides corresponding to your version.
## Native App
An [electron](http://electron.atom.io/)-based desktop client, in its early days, is also available [here](https://github.com/phanan/koel-app).