forked from vikunja/vikunja
Compare commits
1 Commits
main
...
renovate/g
Author | SHA1 | Date | |
---|---|---|---|
e1f58e1345 |
|
@ -36,9 +36,8 @@ Make sure to check the other doc articles for specific development tasks like [t
|
||||||
## Frontend requirements
|
## Frontend requirements
|
||||||
|
|
||||||
The code for the frontend is located at [code.vikunja.io/frontend](https://code.vikunja.io/frontend).
|
The code for the frontend is located at [code.vikunja.io/frontend](https://code.vikunja.io/frontend).
|
||||||
More instructions can be found in the repo's README.
|
|
||||||
|
|
||||||
You need to have [pnpm](https://pnpm.io/) and nodejs in version 16 or 18 installed.
|
You need to have yarn v1 and nodejs in version 16 installed.
|
||||||
|
|
||||||
## Git flow
|
## Git flow
|
||||||
|
|
||||||
|
|
|
@ -98,12 +98,12 @@ Check out the docs [in the frontend repo](https://kolaente.dev/vikunja/frontend/
|
||||||
To run the frontend unit tests, run
|
To run the frontend unit tests, run
|
||||||
|
|
||||||
{{< highlight bash >}}
|
{{< highlight bash >}}
|
||||||
pnpm test:unit
|
yarn test:unit
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
|
||||||
The frontend also has a watcher available that re-runs all unit tests every time you change something.
|
The frontend also has a watcher available that re-runs all unit tests every time you change something.
|
||||||
To use it, simply run
|
To use it, simply run
|
||||||
|
|
||||||
{{< highlight bash >}}
|
{{< highlight bash >}}
|
||||||
pnpm test:unit-watch
|
yarn test:unit-watch
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
|
|
@ -38,7 +38,9 @@ More options are available, please refer to the [magefile docs]({{< ref "../deve
|
||||||
|
|
||||||
The code for the frontend is located at [code.vikunja.io/frontend](https://code.vikunja.io/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/) properly installed on your system.
|
You need to have yarn v1 and nodejs in version 16 installed.
|
||||||
2. Clone the repo with `git clone https://code.vikunja.io/frontend` and switch into the directory.
|
|
||||||
3. Install all dependencies with `pnpm install`
|
1. Make sure [yarn v1](https://yarnpkg.com/getting-started/install) is properly installed on your system.
|
||||||
4. Build the frontend with `pnpm build`. This will result in a static js bundle in the `dist/` folder which you can deploy.
|
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.
|
||||||
|
|
|
@ -1,39 +0,0 @@
|
||||||
---
|
|
||||||
title: "Running Vikunja in a subdirectory"
|
|
||||||
date: 2022-09-23T12:15:04+02:00
|
|
||||||
draft: false
|
|
||||||
menu:
|
|
||||||
sidebar:
|
|
||||||
parent: "setup"
|
|
||||||
---
|
|
||||||
|
|
||||||
# Running Vikunja in a subdirectory
|
|
||||||
|
|
||||||
Running Vikunja in a subdirectory is not supported out of the box.
|
|
||||||
However, you can still run it in a subdirectory but need to build the frontend yourself.
|
|
||||||
|
|
||||||
## Frontend
|
|
||||||
|
|
||||||
First, make sure you're able to build the frontend from source.
|
|
||||||
Check [the guide about building from source]({{< ref "build-from-source.md">}}#frontend) about that.
|
|
||||||
|
|
||||||
Then, run
|
|
||||||
|
|
||||||
```
|
|
||||||
pnpm vite build --base=/SUBPATH
|
|
||||||
pnpm workbox copyLibraries dist/
|
|
||||||
```
|
|
||||||
|
|
||||||
Where `SUBPATH` is the subdirectory you want to run Vikunja on.
|
|
||||||
|
|
||||||
Once you have the build files you can deploy them as usual.
|
|
||||||
Note that when deploying in docker you'll need to put the files in a web container yourself, you
|
|
||||||
can't use the `Dockerfile` in the repo without modifications.
|
|
||||||
|
|
||||||
## API
|
|
||||||
|
|
||||||
If you're not using a reverse proxy you're good to go.
|
|
||||||
Simply configure the api url in the frontend as you normally would.
|
|
||||||
|
|
||||||
If you're using a reverse proxy you'll need to adjust the paths so that the api is available at `/SUBPATH/api/v1`.
|
|
||||||
You can check if everything is working correctly by opening `/SUBPATH/api/v1/info` in a browser.
|
|
2
go.mod
2
go.mod
|
@ -66,7 +66,7 @@ require (
|
||||||
golang.org/x/image v0.0.0-20220722155232-062f8c9fd539
|
golang.org/x/image v0.0.0-20220722155232-062f8c9fd539
|
||||||
golang.org/x/oauth2 v0.0.0-20220808172628-8227340efae7
|
golang.org/x/oauth2 v0.0.0-20220808172628-8227340efae7
|
||||||
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4
|
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4
|
||||||
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab
|
golang.org/x/sys v0.0.0-20220919091848-fb04ddd9f9c8
|
||||||
golang.org/x/term v0.0.0-20220722155259-a9ba230a4035
|
golang.org/x/term v0.0.0-20220722155259-a9ba230a4035
|
||||||
gopkg.in/d4l3k/messagediff.v1 v1.2.1
|
gopkg.in/d4l3k/messagediff.v1 v1.2.1
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gopkg.in/yaml.v3 v3.0.1
|
||||||
|
|
2
go.sum
2
go.sum
|
@ -1158,6 +1158,8 @@ golang.org/x/sys v0.0.0-20220808155132-1c4a2a72c664 h1:v1W7bwXHsnLLloWYTVEdvGvA7
|
||||||
golang.org/x/sys v0.0.0-20220808155132-1c4a2a72c664/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.0.0-20220808155132-1c4a2a72c664/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab h1:2QkjZIsXupsJbJIdSjjUOgWK3aEtzyuh2mPt3l/CkeU=
|
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab h1:2QkjZIsXupsJbJIdSjjUOgWK3aEtzyuh2mPt3l/CkeU=
|
||||||
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.0.0-20220919091848-fb04ddd9f9c8 h1:h+EGohizhe9XlX18rfpa8k8RAc5XyaeamM+0VHRd4lc=
|
||||||
|
golang.org/x/sys v0.0.0-20220919091848-fb04ddd9f9c8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
|
golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
|
||||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
|
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211 h1:JGgROgKl9N8DuW20oFS5gxc+lE67/N3FcwmBPMe7ArY=
|
||||||
|
|
Loading…
Reference in New Issue
Block a user