diff --git a/docs/content/doc/development/development.md b/docs/content/doc/development/development.md index 262df519c..7c70bb12f 100644 --- a/docs/content/doc/development/development.md +++ b/docs/content/doc/development/development.md @@ -26,7 +26,7 @@ If you plan to do a bigger change, it is better to open an issue for discussion The code for the api is located at [code.vikunja.io/api](https://code.vikunja.io/api). -We use go modules to manage third-party libraries for Vikunja, so you'll need at least go `1.11` to use these. +We use go modules to manage third-party libraries for Vikunja, so you'll need at least go `1.17` to use these. A lot of developing tasks are automated using a Magefile, so make sure to [take a look at it]({{< ref "mage.md">}}). diff --git a/docs/content/doc/setup/build-from-source.md b/docs/content/doc/setup/build-from-source.md index 06f83b9c9..081706acb 100644 --- a/docs/content/doc/setup/build-from-source.md +++ b/docs/content/doc/setup/build-from-source.md @@ -10,20 +10,37 @@ menu: # Build Vikunja from source -Vikunja being a go application, has no other dependencies than go itself. -All libraries are bundeled inside the repo in the `vendor/` folder, so all it boils down to are these steps: +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.17`. 2. Make sure [Mage](https://magefile) is properly installed on your system. -3. Clone the repo with `git clone https://code.vikunja.io/api` +3. Clone the repo with `git clone https://code.vikunja.io/api` and switch into the directory. 3. Run `mage build: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. *Note:* Static ressources such as email templates are built into the binary. For these to work, you may need to run `mage build:generate` before building the vikunja binary. When builing entirely with `mage`, you dont need to do this, `mage build:generate` will be run automatically when running `mage build:build`. -# Build for different architectures +### 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. \ No newline at end of file +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). + +You need to have yarn v1 and nodejs in version 16 installed. + +1. Make sure [yarn v1](https://yarnpkg.com/getting-started/install) is properly installed on your system. +3. Clone the repo with `git clone https://code.vikunja.io/frontend` and switch into the directory. +3. Install all dependencies with `yarn install` +4. Build the frontend with `yarn build`. This will result in a js bundle in the `dist/` folder which you can deploy.