local-it/vikunja-api
0
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

fix(docs): document pnpm instead of yarn

Browse source
This commit is contained in:
kolaente 2022-09-23 12:26:42 +02:00
parent 2efc1b5a87
commit 2e3603507c
No known key found for this signature in database
GPG key ID: F40E70337AB24C9B
3 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/content/doc/development/development.md
View file

@ -36,8 +36,9 @@ 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 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 ## Git flow

4
docs/content/doc/development/test.md
View file

@ -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 >}}
yarn test:unit pnpm 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 >}}
yarn test:unit-watch pnpm test:unit-watch
{{< /highlight >}} {{< /highlight >}}

10
docs/content/doc/setup/build-from-source.md
View file

@ -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). 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 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.
1. Make sure [yarn v1](https://yarnpkg.com/getting-started/install) is properly installed on your system. 3. Install all dependencies with `pnpm install`
3. Clone the repo with `git clone https://code.vikunja.io/frontend` and switch into the directory. 4. Build the frontend with `pnpm build`. This will result in a static js bundle in the `dist/` folder which you can deploy.
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.