Skip to content

Commit 1bdc55f

Browse files
🕶
1 parent f2b21cf commit 1bdc55f

File tree

3 files changed

+38
-23
lines changed

3 files changed

+38
-23
lines changed

contributing.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,39 @@ Suggestions and pull requests are highly encouraged. Have a look at the [open is
44

55
## Development
66

7-
To develop the project locally, you'll need a recent version of Node.js and `yarn` v1 installed globally.
7+
To develop the project locally, you'll need a recent version of Node.js and `pnpm` installed globally.
88

9-
To get started, clone the repo and run `yarn` from the root directory:
9+
To get started, clone the repo and run `pnpm` from the root directory:
1010

1111
```bash
1212
git clone https://github.com/NotionX/react-notion-x.git
1313
cd react-notion-x
14-
yarn
14+
pnpm
1515
```
1616

1717
This will install dependencies and link all of the local packages together using `lerna`. This includes the example projects which will now point to the local version of your packages.
1818

1919
```bash
20-
yarn dev
20+
pnpm dev
2121
```
2222

23-
This starts compiling the packages into their respective `build` folders. Under the hood, it is running `tsc --watch` and `tsup --watch`, so every time you make a change to one of the packages, the build will be updated automatically as long as this command is running.
23+
This starts compiling the packages into their respective `build` folders
2424

25-
With `yarn dev` running in one tab, we recommend opening a second tab and navigating to the `examples/minimal` directory.
25+
With `pnpm dev` running in one tab, we recommend opening a second tab and navigating to the `examples/minimal` directory.
2626

2727
```bash
2828
cd examples/minimal
29-
yarn dev
29+
pnpm dev
3030
```
3131

32-
Running `yarn dev` from the `examples/minimal` directory will start the example project's Next.js dev server. This project should be using your locally built version of the libraries because they have been linked using `lerna`.
32+
Running `pnpm dev` from the `examples/minimal` directory will start the example project's Next.js dev server. This project ill be using your locally built version of the libraries.
3333

3434
You should now be able to open `http://localhost:3000` to view and debug the example project.
3535

3636
### Gotchas
3737

38-
Whenever you make a change to one of the packages, the `yarn dev` from the project root will re-compile that package, and the `yarn dev` from the example project's Next.js dev server should hot-reload it in the browser.
38+
Whenever you make a change to one of the packages, the `pnpm dev` from the project root will re-compile that package, and the `pnpm dev` from the example project's Next.js dev server should hot-reload it in the browser.
3939

40-
Sometimes, this process gets a little out of whack, and if you're not sure what's going on, I usually just quit one or both of the `yarn dev` commands and restart them.
40+
Sometimes, this process gets a little out of whack, and if you're not sure what's going on, I usually just quit one or both of the `pnpm dev` commands and restart them.
4141

42-
If you're seeing something unexpected while debugging one of the Next.js demos, try running `rm -rf .next` to refresh the Next.js cache before running `yarn dev` again.
42+
If you're seeing something unexpected while debugging one of the Next.js demos, try running `rm -rf .next` to refresh the Next.js cache before running `pnpm dev` again.

lerna.json

-9
This file was deleted.

pnpm-lock.yaml

+27-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)