Build Vikunja from source #
To completely build Vikunja from source, you need to build the api and frontend.
Table of contents
API #
The Vikunja API has no other dependencies than go itself. That means compiling it boils down to these steps:
- Make sure Go is properly installed on your system. You’ll need at least Go
1.19
. - Make sure Mage is properly installed on your system.
- Clone the repo with
git clone https://code.vikunja.io/api
and switch into the directory. - Run
mage build
in the source of this repo. This will build a binary in the root of the repo which will be able to run on your system.
Build for different architectures #
To build for other platforms and architectures than the one you’re currently on, simply run mage release:release
or mage release:{linux|windows|darwin}
.
More options are available, please refer to the magefile docs for more details.
Frontend #
The code for the frontend is located at code.vikunja.io/frontend.
- Make sure you have pnpm properly installed on your system.
- Clone the repo with
git clone https://code.vikunja.io/frontend
and switch into the directory. - Install all dependencies with
pnpm install
- Build the frontend with
pnpm run build
. This will result in a static js bundle in thedist/
folder which you can deploy.