Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.17 KB

contributing.md

File metadata and controls

42 lines (26 loc) · 2.17 KB
Raw

Contributing

Suggestions and pull requests are highly encouraged. Have a look at the open issues, especially the easy ones.

Development

To develop the project locally, you'll need a recent version of Node.js and yarn v1 installed globally.

To get started, clone the repo and run yarn from the root directory:

git clone https://github.com/NotionX/react-notion-x.git
cd react-notion-x
yarn

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.

yarn dev

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.

With yarn dev running in one tab, we recommend opening a second tab and navigating to the examples/minimal directory.

cd examples/minimal
yarn dev

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.

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

Gotchas

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.

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.

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.