Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace yarn with pnpm in docs #517

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/contributing-guide/environment-setup/mac-os.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,12 @@ Chatwoot requires `node` version `20`. Install Node.js from NodeSource using the
brew install node@20
```

### Install yarn
### Install pnpm

We use `yarn` as package manager
We use `pnpm` as package manager

```bash
brew install yarn
brew install pnpm
```

### Install postgres
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/environment-setup/make.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ cd chatwoot

## Install Ruby & JavaScript dependencies

Install Ruby and JavaScript dependencies using the following command. This command runs Bundler and Yarn:
Install Ruby and JavaScript dependencies using the following command. This command runs Bundler and pnpm:
```
make burn
```
Expand Down
11 changes: 3 additions & 8 deletions docs/contributing-guide/environment-setup/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,17 +54,12 @@ curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs
```

### Install yarn
### Install pnpm

We use `yarn` as the package manager:
We use `pnpm` as the package manager:

```bash
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
```

```bash
sudo apt-get update && sudo apt-get install yarn
curl -fsSL https://get.pnpm.io/install.sh | sh -
```

### Install postgres
Expand Down
11 changes: 3 additions & 8 deletions docs/contributing-guide/environment-setup/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,12 @@ curl -sL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs
```

### Install yarn
### Install pnpm

We use `yarn` as the package manager
We use `pnpm` as the package manager

```bash
curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
```

```bash
sudo apt-get update && sudo apt-get install yarn
npm install -g pnpm
```

### Install postgres
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/mobile-app/setup-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ title: "Setup guide for mobile app"

- [Node.js](https://nodejs.org/en/download/)
- [Watchman](https://facebook.github.io/watchman/docs/install.html)
- [Yarn](https://yarnpkg.com/en/docs/install)
- [pnpm](https://pnpm.io/installation)

To learn more about the most up-to-date instructions, please refer to the guide available [here](https://reactnative.dev/docs/environment-setup?guide=native).

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing-guide/project-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ cd chatwoot

### Install Ruby & Javascript dependencies

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

```bash
make burn
Expand Down Expand Up @@ -128,7 +128,7 @@ https://docs.cypress.io/guides/overview/why-cypress.html
# in terminal tab1
overmind start -f Procfile.test
# in terminal tab2
yarn cypress open --project ./test
pnpm cypress open --project ./test
```


Expand Down
2 changes: 1 addition & 1 deletion docs/contributing-guide/tests/cypress.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ Navigate to your chatwoot local directory and Execute the following command to r


```bash
yarn cypress open --project ./spec
pnpm cypress open --project ./spec
```
4 changes: 2 additions & 2 deletions docs/self-hosted/deployment/clevercloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ To install the dependencies, you have to setup builds hooks. Set the following i

```
CC_POST_BUILD_HOOK="RAILS_ENV=production rails assets:precompile"
CC_PRE_BUILD_HOOK="yarn install"
CC_PRE_BUILD_HOOK="pnpm install"
CC_PRE_RUN_HOOK="rake db:chatwoot_prepare"
```

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

```
CC_POST_BUILD_HOOK="RAILS_ENV=production rails assets:precompile"
CC_PRE_BUILD_HOOK="yarn install"
CC_PRE_BUILD_HOOK="pnpm install"
CC_PRE_RUN_HOOK="rake db:chatwoot_prepare"
DATABASE_URL="<postgres-addon-url>"
FRONTEND_URL="<clever-cloud-app-url>"
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosted/deployment/linux-vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ rvm use 3.2.2 --default

# Update dependencies
bundle
yarn
pnpm install

# Recompile the assets
rake assets:precompile RAILS_ENV=production
Expand Down