DEVELOPMENT.md

How to develop this plugin

Getting started

Clone the dokku repo:

git clone https://github.com/dokku/dokku

Move the discourse plugin repo into the root of the cloned dokku repo. The directory name must be discourse.

Change directory to the root of the dokku repo.

Start the dokku VM using vagrant:

vagrant up dokku

SSH into the dokku VM:

vagrant ssh

# or
ssh [email protected]
su - dokku

Link & enable the plugin:

cd /var/lib/dokku/plugins/available
ln -s /vagrant/discourse
dokku plugin:enable discourse

Now you can work on the plugin from your host machine and run the plugin in the dokku VM.

Tests

Tests must be run within the dokku VM:

sudo apt-get install bats

make test

The tests will take a very long time to run.

Linting

On your host machine:

brew install shellcheck

Debugging

View logs:

dokku logs discourse-app