Go to file
Ashim Sedhain 495ac389e0
[GH-33] fixes nil pointer panic if SiteURL is not set (#35)
2020-09-22 11:58:49 +02:00
.circleci Unify structure with other plugins 2019-08-07 15:07:45 +02:00
build [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
server [GH-33] fixes nil pointer panic if SiteURL is not set (#35) 2020-09-22 11:58:49 +02:00
.editorconfig Unify structure with other plugins 2019-08-07 15:07:45 +02:00
.gitignore Unify structure with other plugins 2019-08-07 15:07:45 +02:00
.golangci.yml [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
CODEOWNERS Define maintainer 2020-04-09 17:21:56 +02:00
LICENSE Create LICENSE 2017-12-21 16:05:36 -06:00
Makefile [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
README.md Define maintainer 2020-04-09 17:21:56 +02:00
go.mod [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
go.sum [GH-31] GolangCI-Lint Integration (#32) 2020-08-14 12:22:09 +02:00
plugin.json Fix release_notes_url 2020-07-23 11:49:19 +02:00
screenshot.png add screenshot, travis.yml, bump version to 0.1 2017-12-21 15:25:22 -06:00

README.md

Mattermost Memes Plugin

Build Status Code Coverage

Maintainer: @hanzei

This plugin will create a slash command that you can use to create memes!

/meme memes. memes everywhere

For more information like available memes or command syntax type /meme and press enter.

Installation

Go to the GitHub releases tab and download the latest release for your server architecture. You can upload this file in the Mattermost system console to install the plugin.

Developing

Run make vendor to install third-party dependencies and make memelibrary/assets.go to bundle up the meme assets (images, fonts, etc.). From there, you can develop like any other Go project: Hack away and use go test, go build, etc.

For convenience, you can run the plugin from your terminal to preview an image for a given input. For example, on macOS, you can run the following to generate the above meme and open it in Preview:

go run plugin.go -out demo.jpg 'memes. memes everywhere' && open demo.jpg

This is especially useful when adding or modifying memes as you can quickly modify assets, make memelibrary/assets.go, and preview the result using the above command. (See the files in memelibrary/assets to get started with that.)

If you want to create a fully bundled plugin that will run on a local server, you can use make mattermost-memes-plugin.tar.gz.

Releasing

To make a release, update the version number in plugin.yaml, and create a release via the GitHub interface. CircleCI will upload the distributables for you.