starred/koel-koel

Fork 0

mirror of https://github.com/koel/koel.git synced 2026-04-25 08:46:00 +03:00

[PR #975] [MERGED] Make it easier to contribute to koel by having an online IDE #1486

New issue

Closed

opened 2026-02-26 03:31:12 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 03:31:12 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/koel/koel/pull/975
Author: @meysholdt
Created: 5/17/2019
Status: ✅ Merged
Merged: 5/21/2019
Merged by: @phanan

Base: master ← Head: master

📝 Commits (2)

7e251c2 Added Gitpod Config
6942f70 Start with music in the playlist

📊 Changes

3 files changed (+45 additions, -0 deletions)

View changed files

➕ .gitpod.dockerfile (+3 -0)
➕ .gitpod.yml (+38 -0)
📝 README.md (+4 -0)

📄 Description

Hi There! hi @phanan!

I wanted to try koel but setting up may dev environment took painfully long. All that tinkering...

So I thought we can make that easier for everybody by having an online IDE (gitpod.io)) where everything is already configured, so that one can start running and hacking koel with just one click.

If you click on the following link....
https://gitpod.io/#https://github.com/meysholdt/koel

a new docker-based workspace will launch. It's built from the Dockerfile in this PR
A git clone will fetch the koel source code. You may need to GitHub-OAuth-Login here.
the .env.example script is copied to .env
int the workspace, MySQL is started and a user+database based on the .env is created.
php artisan koel:init runs to let the user create a new login
an apache web server starts
koel opens in a preview in the IDE

What you see then looks like this:

Disclosure: I work on Gitpod.

Let me know what you think. I hope you find this useful. I personally think this can make it significantly easier to contribute to koel.

There is, however, one problem I ran into. koel seems to have trouble with being behind a https-proxy. This was already reported in #725. This issue bites us when using Gitpod, because you open koel in your browser, your requests go trough a https-proxy (operated by Gitpod) to the koel-instance from your workspace. Unfortunately, koel often sends http requests, even though it's served via https. I'm happy to help out a little, but I'm not enough familiar with koel to do this on my own.

I noticed that composer install and yarn install take several minutes to run. If you configure the Gitpod App on this repo, Gitpod can run them on git-push on branches and PRs. So when you open a workspace, composer install and yarn install will already have finished and you don't need to wait for them.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/koel/koel/pull/975 **Author:** [@meysholdt](https://github.com/meysholdt) **Created:** 5/17/2019 **Status:** ✅ Merged **Merged:** 5/21/2019 **Merged by:** [@phanan](https://github.com/phanan) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (2) - [`7e251c2`](https://github.com/koel/koel/commit/7e251c2c9b7b3334905a0ee422a34852f1f80d00) Added Gitpod Config - [`6942f70`](https://github.com/koel/koel/commit/6942f707a75750140e66c15f95a091d26cd1762d) Start with music in the playlist ### 📊 Changes **3 files changed** (+45 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.gitpod.dockerfile` (+3 -0) ➕ `.gitpod.yml` (+38 -0) 📝 `README.md` (+4 -0) </details> ### 📄 Description Hi There! hi @phanan! I wanted to try koel but setting up may dev environment took painfully long. All that tinkering... So I thought we can make that easier for everybody by having an online IDE ([gitpod.io](https://www.gitpod.io))) where everything is already configured, so that one can start running and hacking koel with just one click. If you click on the following link.... https://gitpod.io/#https://github.com/meysholdt/koel 1. a new docker-based workspace will launch. It's built from the `Dockerfile` in this PR 2. A `git clone` will fetch the koel source code. You may need to GitHub-OAuth-Login here. 3. the `.env.example` script is copied to `.env` 4. int the workspace, MySQL is started and a user+database based on the `.env` is created. 5. `php artisan koel:init` runs to let the user create a new login 6. an apache web server starts 7. koel opens in a preview in the IDE What you see then looks like this: ![image](https://user-images.githubusercontent.com/239422/57939229-27532c80-78ca-11e9-913a-56e4d3519913.png) Disclosure: I work on Gitpod. Let me know what you think. I hope you find this useful. I personally think this can make it significantly easier to contribute to koel. There is, however, one problem I ran into. koel seems to have trouble with being behind a https-proxy. This was already reported in #725. This issue bites us when using Gitpod, because you open koel in your browser, your requests go trough a https-proxy (operated by Gitpod) to the koel-instance from your workspace. Unfortunately, koel often sends `http` requests, even though it's served via `https`. I'm happy to help out a little, but I'm not enough familiar with koel to do this on my own. I noticed that `composer install` and `yarn install` take several minutes to run. If you configure the [Gitpod App](https://github.com/apps/gitpod-io) on this repo, Gitpod can run them on git-push on branches and PRs. So when you open a workspace, `composer install` and `yarn install` will already have finished and you don't need to wait for them. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

kerem

2026-02-26 03:31:12 +03:00

closed this issue
added the
pull-request
label

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

starred/koel-koel#1486

No description provided.

Rows
Columns