From 2e3603507c653d2d368e59df8b2d11f31bd2df38 Mon Sep 17 00:00:00 2001 From: kolaente Date: Fri, 23 Sep 2022 12:26:42 +0200 Subject: [PATCH] fix(docs): document pnpm instead of yarn --- docs/content/doc/development/development.md | 3 ++- docs/content/doc/development/test.md | 4 ++-- docs/content/doc/setup/build-from-source.md | 10 ++++------ 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/content/doc/development/development.md b/docs/content/doc/development/development.md index 7c70bb12..158385fe 100644 --- a/docs/content/doc/development/development.md +++ b/docs/content/doc/development/development.md @@ -36,8 +36,9 @@ Make sure to check the other doc articles for specific development tasks like [t ## Frontend requirements 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 yarn v1 and nodejs in version 16 installed. +You need to have [pnpm](https://pnpm.io/) and nodejs in version 16 or 18 installed. ## Git flow diff --git a/docs/content/doc/development/test.md b/docs/content/doc/development/test.md index 0d9c2097..3e8c23b6 100644 --- a/docs/content/doc/development/test.md +++ b/docs/content/doc/development/test.md @@ -98,12 +98,12 @@ Check out the docs [in the frontend repo](https://kolaente.dev/vikunja/frontend/ To run the frontend unit tests, run {{< highlight bash >}} -yarn test:unit +pnpm test:unit {{< /highlight >}} The frontend also has a watcher available that re-runs all unit tests every time you change something. To use it, simply run {{< highlight bash >}} -yarn test:unit-watch +pnpm test:unit-watch {{< /highlight >}} diff --git a/docs/content/doc/setup/build-from-source.md b/docs/content/doc/setup/build-from-source.md index 210912ca..0d0fa610 100644 --- a/docs/content/doc/setup/build-from-source.md +++ b/docs/content/doc/setup/build-from-source.md @@ -38,9 +38,7 @@ 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). -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. +1. Make sure you have [pnpm](https://pnpm.io/) 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 build`. This will result in a static js bundle in the `dist/` folder which you can deploy.