Mattermost Plugin Starter Template

Plugin Starter Template

[](https://github.com/mattermost/mattermost-plugin-starter-template/actions/workflows/ci.yml) [](https://github.com/mattermost/mattermost-plugin-starter-template/actions/workflows/e2e.yml)

This plugin serves as a starting point for writing a Mattermost plugin. Feel free to base your own plugin off this repository.

To learn more about plugins, see [our plugin documentation](https://developers.mattermost.com/extend/plugins/).

This template requires node v16 and npm v8. You can download and install nvm to manage your node versions by following the instructions [here](https://github.com/nvm-sh/nvm). Once you've setup the project simply run `nvm i` within the root folder to use the suggested version of node.

Getting Started

Use GitHub's template feature to make a copy of this repository by clicking the "Use this template" button.

Alternatively shallow clone the repository matching your plugin name:

git clone --depth 1 https://github.com/mattermost/mattermost-plugin-starter-template com.example.my-plugin

Note that this project uses [Go modules](https://github.com/golang/go/wiki/Modules). Be sure to locate the project outside of `$GOPATH`.

Edit the following files:

1. plugin.json with your id, name, and description:

{
    "id": "com.example.my-plugin",
    "name": "My Plugin",
    "description": "A plugin to enhance Mattermost."
}

1. go.mod with your Go module path, following the // convention:

module github.com/example/my-plugin

1. Replace all occurrences of github.com/mattermost/mattermost-plugin-starter-template in the codebase with your Go module path:

sed -i '' 's|github.com/mattermost/mattermost-plugin-starter-template|