koel/README.md

22 lines
1.3 KiB
Markdown
Raw Normal View History

2016-05-27 04:01:14 +00:00
# koel [![Build Status](https://travis-ci.org/phanan/koel.svg?branch=master)](https://travis-ci.org/phanan/koel)
2015-12-14 09:13:29 +00:00
2016-01-31 13:59:05 +00:00
![Showcase](http://koel.phanan.net/dist/img/showcase.png?2)
2015-12-13 02:19:46 +00:00
## 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
2016-02-19 10:04:29 +00:00
**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.
2015-12-13 02:19:46 +00:00
## Install and Upgrade Guide
2015-12-28 01:47:18 +00:00
For system requirements, installation guides, and troubleshooting, head over to [Wiki](https://github.com/phanan/koel/wiki).
2016-01-31 13:59:05 +00:00
If you are upgrading, see [Releases](https://github.com/phanan/koel/releases) for guides corresponding to your version.
2016-03-14 13:37:19 +00:00
## Native App
2016-03-14 13:37:19 +00:00
An [electron](http://electron.atom.io/)-based desktop client, in its early days, is also available [here](https://github.com/phanan/koel-app).