mirror of https://github.com/koel/koel synced 2024-11-12 23:47:09 +00:00

No description

Find a file

Phan An cd86c44477 chore(release): bump version to v7.2.0		2024-10-31 20:57:32 +07:00
.github	feat(build): use action-gh-release instead of deprecated GH actions for release (#1834 )	2024-10-01 18:27:37 +02:00
.husky	build: add pre-commit hook to enforce conventional commits	2024-08-23 11:16:26 +02:00
.vscode	feat: use a better ESLint setup (#1850 )	2024-10-14 00:37:01 +07:00
api-docs	feat: add and use "last played" timestamp for songs (#1578 )	2022-11-08 18:38:28 +01:00
app	feat: ensure current branch is `master` for release	2024-10-31 20:56:50 +07:00
bootstrap	chore: remove custom Application file	2021-01-10 23:18:21 +01:00
config	fix: ensure default storage is local (#1840 )	2024-10-06 22:57:25 +02:00
cypress	refactor: rename Extra Drawer to Side Sheet (#1853 )	2024-10-15 22:19:37 +07:00
database	feat: replace attempt() with built-in rescue() (#1833 )	2024-10-01 00:15:38 +02:00
docs	docs: link to VitePress & fix grammar mistake	2024-10-24 20:28:52 +07:00
public	fix: add avatar and playlist image folders	2024-07-16 20:37:09 +02:00
resources	fix: options to mark songs as private/public shown in Community edition (#1870 )	2024-10-31 17:55:09 +07:00
routes	feat: allow bitrate options for mobile transcoding	2024-09-03 16:51:23 +02:00
storage	fix(tests): broken tests after Saloon migration	2024-07-06 17:44:54 +02:00
tests	refactor: use attributes for tests (#1858 )	2024-10-24 17:45:45 +07:00
.editorconfig	feat: custom profile avatar	2024-07-06 17:44:52 +02:00
.env.example	feat: use transcode-and-cache instead of direct on-the-fly transcode&streaming	2024-09-03 12:52:07 +02:00
.gitignore	chore: remove overlay outline	2024-07-06 17:44:58 +02:00
.htaccess.example	fix: .htaccess customizations get overwritten with updates (#1762 )	2024-04-24 17:02:05 +02:00
.version	chore(release): bump version to v7.2.0	2024-10-31 20:57:32 +07:00
artisan	Big Bang	2015-12-13 12:42:28 +08:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2020-09-14 09:48:41 +02:00
commitlint.config.js	build: add pre-commit hook to enforce conventional commits	2024-08-23 11:16:26 +02:00
composer.json	feat(dev): use concurrently to start dev servers (#1849 )	2024-10-13 20:37:57 +07:00
composer.lock	chore(build): upgrade poddle	2024-10-31 16:18:13 +07:00
cypress.json	feat(build): add Cypress build integration	2021-01-03 20:41:14 +01:00
eslint.config.js	chore(cs): apply linting on CSS and JS too	2024-10-14 23:24:12 +07:00
LICENSE.md	chore: correct license date	2024-07-06 17:44:51 +02:00
nginx.conf.example	feat: add sensitive default upload settings	2023-04-17 00:10:34 +02:00
package.json	chore: upgrade axios	2024-10-15 16:09:55 +07:00
phpstan.neon.dist	fix(build): fixing build errors	2024-07-07 22:52:27 +02:00
phpunit.xml.dist	feat: upgrade PHPUnit	2024-07-06 17:44:58 +02:00
postcss.config.cjs	feat(ui): use Tailwind CSS	2024-07-06 17:44:57 +02:00
README.md	fix: doc urls	2024-07-06 17:44:48 +02:00
ruleset.xml	chore: wrong ruleset name	2024-08-29 20:42:33 +02:00
server.php	chore: use Laravel' original structure	2020-09-12 17:14:34 +02:00
tailwind.config.js	refactor: rename Extra Drawer to Side Sheet (#1853 )	2024-10-15 22:19:37 +07:00
vite.config.js	chore: replace Sass with PostCSS	2024-07-06 17:44:57 +02:00
yarn.lock	chore(build): upgrade caniuse	2024-10-26 00:58:12 +07:00

README.md

koel

Intro

Koel (also stylized as koel, with a lowercase k) is a simple web-based personal audio streaming service written in Vue on the client side and Laravel on the server side. Targeting web developers, Koel embraces some of the more modern web technologies to do its job.

Install and Upgrade Guide

For system requirements, installation/upgrade guides, troubleshooting etc., head over to the Official Documentation.

Development

See the Development Guide.

Koel Player

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.