Readeck Development

You found a bug you'd like to tackle yourself, you'd love to improve the documentation or you want to contribute a new feature. That's fantastic, welcome on board! (or maybe, you only want to compile Readeck; that's fine too.) Please read the contribution guidelines beforehand.

To compile Readeck you need the following requirements on your system:

Go version 1.25 or higher
NodeJS version 20 or higher
Git
GNU Make

Clone Readeck

First, you'll need to clone Readeck:

git clone https://codeberg.org/readeck/readeck.git

Compile Readeck

To compile Readeck, go into the cloned folder and build it:

cd readeck
make setup
make all

If all goes well, Readeck is available as dist/readeck.

Step by step

If you encounter issues while building, try to build using a more step by step approach so you can pinpoint the issue:

make setup
make web-build
make docs-build
make build

Working on the server

Readeck provides some developer features that let you start a server that automatically restarts upon code change.

To start the full stack, simply run:

make dev

If you're working on Go files only, you can start a more lightweight watcher:

make generate # only to ensure the assets are built the first time
make serve

The default logger of the server process outputs JSON. To opt into a human-readable, ANSI-colored log format meant for the terminal, run:

READECK_LOG_FORMAT=dev READECK_LOG_LEVEL=debug make serve

Checking your changes

Before submitting a contribution, please check that both the following commands are successful:

make lint
make test

Readeck