Home TRMNL

Important

This is still a tinkerer's project, still in its infancy and being developed primarily for my needs. Use at your own risk. A CHANGELOG is being maintained starting from v0.4.3.

A home-made TRMNL server that is solely driven by a single configuration file.

Getting Started

Please refer to the Getting Started guide in the documentation.

Local Development

Note

You will need Node.js v24 (or higher), PNPM and Docker installed.

Running

First create a data directory using the config.example.yaml file included in this project:

mkdir example && cp config.example.yaml example/config.yaml

Then ensure that logs are enabled (the server uses the debug library):

export DEBUG=home-trmnl:*

Now you are ready to start the server that will be running on port 1992:

pnpm run start

Tip

You can set the HT_HOST environment variable if you want to run the server on an alternative host. By default it runs on localhost.

Code Quality

To perform code quality checks, powered by ESLint, run this command:

pnpm run lint

Please refer to the eslint.config.js file to familiar yourself with the rules.

Tests

To run project tests, run this command:

pnpm test

Note

Test coverage is still not there yet; there is only robust functionality coverage for the panels.

Building

To build a Docker image, run this command:

docker build -t home-trmnl-server .