2024-01-09 16:04:04 +00:00
# koel [](https://github.com/koel/koel/actions/workflows/unit-frontend.yml)  [](https://codecov.io/gh/koel/koel) [](#backers) [](#sponsors)
2015-12-14 09:13:29 +00:00
2021-04-16 13:02:58 +00:00
2015-12-13 02:19:46 +00:00
2016-03-20 14:37:13 +00:00
## Intro
2022-08-08 16:21:34 +00:00
**Koel** (also stylized as **koel** , with a lowercase k) is a simple web-based personal audio streaming service written
in [Vue ](http://vuejs.org/ ) on the client side and [Laravel ](http://laravel.com/ ) on the server side. Targeting web
developers, Koel embraces some of the more modern web technologies to do its job.
2015-12-13 02:19:46 +00:00
2016-03-20 14:37:13 +00:00
## Install and Upgrade Guide
2022-08-08 16:21:34 +00:00
For system requirements, installation/upgrade guides, troubleshooting etc., head over to
the [Official Documentation ](https://docs.koel.dev ).
2016-03-14 13:37:19 +00:00
2020-12-30 00:30:32 +00:00
## Development
2018-10-06 11:01:18 +00:00
2022-08-08 16:21:34 +00:00
See the [Development Guide ](https://docs.koel.dev/#local-development ).
2019-05-21 09:52:35 +00:00
2021-07-25 17:07:00 +00:00
## Koel Player
2022-08-08 16:21:34 +00:00
[Koel Player ](https://github.com/koel/player ) is the official mobile app for Koel, which supports both iOS and Android
without the limitations of the mobile web version. For more information on the project,
visit [its repository ](https://github.com/koel/player ).
2021-07-25 17:07:00 +00:00
2024-06-26 09:18:24 +00:00
## Sponsors and Backers
[<img style="margin-right: 5px" src="./.github/assets/sponsors/keycdn.svg" height="42" alt="KeyCDN logo" title="KeyCDN - Content Delivery Made Easy"> ](https://www.keycdn.com/?a=11519 )
[<img style="margin-right: 5px" src="./.github/assets/sponsors/whatthediff.svg" height="32" alt="What The Diff logo" title="What The Diff — AI assistant for your pull requests"> ](https://whatthediff.ai/ )
[<img style="margin-right: 5px" src="./.github/assets/sponsors/do.svg" height="32" alt="DigitalOcean logo" title="DigitalOcean"> ](https://www.digitalocean.com )
[<img style="margin-right: 5px" src="./.github/assets/sponsors/ray.svg" height="32" alt="Ray logo" title="Understand and fix bugs faster using Ray"> ](https://myray.app/ )
2016-06-13 09:08:12 +00:00
2022-08-08 16:21:34 +00:00
[Support me on OpenCollective ](https://opencollective.com/koel#backer ) with a monthly donation and help me continue
building Koel.
2016-06-13 09:08:12 +00:00
< a href = "https://opencollective.com/koel/backer/0/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/1/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/2/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/3/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/4/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/5/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/6/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/7/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/8/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/9/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/backer/10/website" target = "_blank" > < img src = "https://opencollective.com/koel/backer/10/avatar.svg" > < / a >
2024-06-26 09:18:24 +00:00
### GitHub Sponsors
2019-07-09 21:27:21 +00:00
2019-07-17 18:29:05 +00:00
* [You ](https://github.com/users/phanan/sponsorship )?
2019-07-09 21:27:21 +00:00
2024-06-26 09:18:24 +00:00
### OpenCollective
2019-07-09 21:27:21 +00:00
2024-06-26 09:18:24 +00:00
[Become a sponsor on OpenCollective ](https://opencollective.com/koel#sponsor ) and get your logo on this README on Github
2022-08-08 16:21:34 +00:00
with a link to your site.
2016-06-13 09:08:12 +00:00
< a href = "https://opencollective.com/koel/sponsor/0/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/0/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/1/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/1/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/2/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/2/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/3/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/3/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/4/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/4/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/5/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/5/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/6/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/6/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/7/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/7/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/8/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/8/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/9/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/9/avatar.svg" > < / a >
< a href = "https://opencollective.com/koel/sponsor/10/website" target = "_blank" > < img src = "https://opencollective.com/koel/sponsor/10/avatar.svg" > < / a >
