A template to get started with matrix-bot-starter!
This template is just a starting off point. For documentation of the matrix-bot-starter, please check out its repository.
- Clone the repository.
- Either enter LOGINNAME & PASSWORD in .env, or generate an access token for your bot user (see t2bot.io/docs/access_tokens/).
- Rename .env.example to .env and change the values.
- Run
npm install && npm build.
| npm run | function |
|---|---|
| start | Run build/index.js |
| dev | Run & watch app/index.ts |
| build | Build app/ into build/ |
| start-docker | Run the Dockerfile |
| dev-docker | Build & run the Dockerfile |
| build-docker | Copy .env to .env.docker & build the image |
- app/
- index.ts: basic boilerplate for the bot client.
- assets/: Images (and an image script) for use in the README.
- build/: Made during runtime. Compiled javascript code.
- .env: Manually made. Environment variables to use when running locally.
- .env.docker Manually made or generated from .env. Environment variables for use in Docker.
This template is in the public domain. Matrix-Bot-Starter is licensed under the MIT License.