vikunja-api/docs/content/doc/setup/build-from-source.md

---
date: "2022-09-21:00:00+02:00"
title: "Build from sources"
draft: false
type: "doc"
menu:
  sidebar:
    parent: "setup"
---

# 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:

1. Make sure [Go](https://golang.org/doc/install) is properly installed on your system. You'll need at least Go `1.21`.
2. Make sure [Mage](https://magefile.org) is properly installed on your system.
3. Clone the repo with `git clone https://code.vikunja.io/api` and switch into the directory.
4. 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]({{< ref "../development/mage.md">}}) for more details.

## Frontend

The code for the frontend is located at [code.vikunja.io/frontend](https://code.vikunja.io/frontend).

1. Make sure you have [pnpm](https://pnpm.io/installation) properly installed on your system.
2. Clone the repo with `git clone https://code.vikunja.io/frontend` and switch into the directory.
3. Install all dependencies with `pnpm install`
4. Build the frontend with `pnpm run build`. This will result in a static js bundle in the `dist/` folder which you can deploy.
Huge improvements for docs (#58) 2019-02-17 19:53:04 +00:00			`---`
feat(docs): document pnpm (#1251) Co-authored-by: Dominik Pschenitschni <mail@celement.de> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/1251 Co-authored-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> Co-committed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> 2022-10-01 15:30:20 +00:00			`date: "2022-09-21:00:00+02:00"`
Huge improvements for docs (#58) 2019-02-17 19:53:04 +00:00			`title: "Build from sources"`
			`draft: false`
			`type: "doc"`
			`menu:`
			`sidebar:`
			`parent: "setup"`
			`---`

			`# Build Vikunja from source`

chore(docs): update docs about compiling from source 2021-11-28 11:56:46 +00:00			`To completely build Vikunja from source, you need to build the api and frontend.`

			`{{< table_of_contents >}}`

			`## API`

feat(docs): document pnpm (#1251) Co-authored-by: Dominik Pschenitschni <mail@celement.de> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/1251 Co-authored-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> Co-committed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> 2022-10-01 15:30:20 +00:00			`The Vikunja API has no other dependencies than go itself.`
chore(docs): update docs about compiling from source 2021-11-28 11:56:46 +00:00			`That means compiling it boils down to these steps:`
Huge improvements for docs (#58) 2019-02-17 19:53:04 +00:00
docs: clarify minimum required go version 2023-11-05 16:09:46 +00:00			1. Make sure [Go](https://golang.org/doc/install) is properly installed on your system. You'll need at least Go `1.21`.
fix: broken link (#27) 2022-04-18 19:00:46 +00:00			`2. Make sure [Mage](https://magefile.org) is properly installed on your system.`
chore(docs): update docs about compiling from source 2021-11-28 11:56:46 +00:00			3. Clone the repo with `git clone https://code.vikunja.io/api` and switch into the directory.
docs: remove outdated information 2023-04-03 10:07:50 +00:00			4. 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.
Added generate as a make dependency for make build Clarify docs on building Signed-off-by: kolaente <k@knt.li> 2020-02-15 10:35:24 +00:00
chore(docs): update docs about compiling from source 2021-11-28 11:56:46 +00:00			`### Build for different architectures`
Huge improvements for docs (#58) 2019-02-17 19:53:04 +00:00
Cleanup references to make 2020-09-03 15:18:41 +00:00			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}`.
Huge improvements for docs (#58) 2019-02-17 19:53:04 +00:00
chore(docs): update docs about compiling from source 2021-11-28 11:56:46 +00:00			`More options are available, please refer to the [magefile docs]({{< ref "../development/mage.md">}}) for more details.`

			`## Frontend`

			`The code for the frontend is located at [code.vikunja.io/frontend](https://code.vikunja.io/frontend).`

feat(docs): document pnpm (#1251) Co-authored-by: Dominik Pschenitschni <mail@celement.de> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/1251 Co-authored-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> Co-committed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> 2022-10-01 15:30:20 +00:00			`1. Make sure you have [pnpm](https://pnpm.io/installation) properly installed on your system.`
fix(docs): document pnpm instead of yarn 2022-09-23 10:26:42 +00:00			2. Clone the repo with `git clone https://code.vikunja.io/frontend` and switch into the directory.
			3. Install all dependencies with `pnpm install`
feat(docs): document pnpm (#1251) Co-authored-by: Dominik Pschenitschni <mail@celement.de> Reviewed-on: https://kolaente.dev/vikunja/api/pulls/1251 Co-authored-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> Co-committed-by: Dominik Pschenitschni <dpschen@noreply.kolaente.de> 2022-10-01 15:30:20 +00:00			4. Build the frontend with `pnpm run build`. This will result in a static js bundle in the `dist/` folder which you can deploy.