Skip to content

Commit 11e3ea0

Browse files
doc: refactor docs to use pnpm (#532)
1 parent 7921ed9 commit 11e3ea0

File tree

8 files changed

+19
-29
lines changed

8 files changed

+19
-29
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ This repository contains the documentation for self-hosted installations, featur
77
## Installation
88

99
```console
10-
yarn install
10+
pnpm install
1111
```
1212

1313
## Local Development
1414

1515
```console
16-
yarn start
16+
pnpm start
1717
```
1818

1919
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
2020

2121
## Build
2222

2323
```console
24-
yarn build
24+
pnpm build
2525
```
2626

2727
This command generates static content into the `build` directory and can be served using any static contents hosting service.

docs/contributing-guide/environment-setup/mac-os.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,12 @@ Chatwoot requires `node` version `20`. Install Node.js from NodeSource using the
6666
brew install node@20
6767
```
6868

69-
### Install yarn
69+
### Install pnpm
7070

71-
We use `yarn` as package manager
71+
We use `pnpm` as package manager
7272

7373
```bash
74-
brew install yarn
74+
brew install pnpm
7575
```
7676

7777
### Install postgres

docs/contributing-guide/environment-setup/make.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ cd chatwoot
1515

1616
## Install Ruby & JavaScript dependencies
1717

18-
Install Ruby and JavaScript dependencies using the following command. This command runs Bundler and Yarn:
18+
Install Ruby and JavaScript dependencies using the following command. This command runs Bundler and pnpm:
1919
```
2020
make burn
2121
```

docs/contributing-guide/environment-setup/ubuntu.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,17 +54,12 @@ curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
5454
sudo apt-get install -y nodejs
5555
```
5656

57-
### Install yarn
57+
### Install pnpm
5858

59-
We use `yarn` as the package manager:
59+
We use `pnpm` as the package manager:
6060

6161
```bash
62-
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
63-
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
64-
```
65-
66-
```bash
67-
sudo apt-get update && sudo apt-get install yarn
62+
curl -fsSL https://get.pnpm.io/install.sh | sh -
6863
```
6964

7065
### Install postgres

docs/contributing-guide/environment-setup/windows.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,12 @@ curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
4747
sudo apt-get install -y nodejs
4848
```
4949

50-
### Install yarn
50+
### Install pnpm
5151

52-
We use `yarn` as the package manager
52+
We use `pnpm` as the package manager
5353

5454
```bash
55-
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
56-
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
57-
```
58-
59-
```bash
60-
sudo apt-get update && sudo apt-get install yarn
55+
iwr https://get.pnpm.io/install.ps1 -useb | iex
6156
```
6257

6358
### Install postgres

docs/contributing-guide/project-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ cd chatwoot
1818

1919
### Install Ruby & Javascript dependencies
2020

21-
Use the following command to run `bundle && yarn` to install ruby and Javascript dependencies.
21+
Use the following command to run `bundle && pnpm install` to install ruby and Javascript dependencies.
2222

2323
```bash
2424
make burn
@@ -96,7 +96,7 @@ docker compose down
9696
docker compose up
9797
```
9898

99-
When you change the services Dockerfile or the contents of the build directory, run stop then build. (For example after modifying package.json or Gemfile)
99+
When you change the service's Dockerfile or the contents of the build directory, run stop then build. (For example after modifying package.json or Gemfile)
100100

101101
```bash
102102
docker compose stop
@@ -128,7 +128,7 @@ https://docs.cypress.io/guides/overview/why-cypress.html
128128
# in terminal tab1
129129
overmind start -f Procfile.test
130130
# in terminal tab2
131-
yarn cypress open --project ./test
131+
pnpm cypress open --project ./test
132132
```
133133

134134

docs/contributing-guide/tests/cypress.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,5 @@ Navigate to your chatwoot local directory and Execute the following command to r
6666

6767

6868
```bash
69-
yarn cypress open --project ./spec
69+
pnpm cypress open --project ./spec
7070
```

docs/self-hosted/deployment/clevercloud.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To install the dependencies, you have to setup builds hooks. Set the following i
4141

4242
```
4343
CC_POST_BUILD_HOOK="RAILS_ENV=production rails assets:precompile"
44-
CC_PRE_BUILD_HOOK="yarn install"
44+
CC_PRE_BUILD_HOOK="pnpm install"
4545
CC_PRE_RUN_HOOK="rake db:chatwoot_prepare"
4646
```
4747

@@ -61,7 +61,7 @@ Make sure you have the following environment variables configured in the applica
6161

6262
```
6363
CC_POST_BUILD_HOOK="RAILS_ENV=production rails assets:precompile"
64-
CC_PRE_BUILD_HOOK="yarn install"
64+
CC_PRE_BUILD_HOOK="pnpm install"
6565
CC_PRE_RUN_HOOK="rake db:chatwoot_prepare"
6666
DATABASE_URL="<postgres-addon-url>"
6767
FRONTEND_URL="<clever-cloud-app-url>"

0 commit comments

Comments
 (0)