d0zingcat/nextjs-notion-starter-kit
1
0
Fork 0
mirror of https://github.com/d0zingcat/nextjs-notion-starter-kit.git synced 2026-05-13 23:16:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add contributing guide

Browse Source
This commit is contained in:
Travis Fischer
2022-03-25 20:07:42 -04:00
parent b9febad145
commit 18db0747d6
2 changed files with 87 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

83
contributing.md Normal file
View File

@@ -0,0 +1,83 @@
# Contributing
Suggestions and pull requests are highly encouraged. Have a look at the [open issues](https://github.com/NotionX/react-notion-x/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc), especially [the easy ones](https://github.com/NotionX/react-notion-x/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+sort%3Areactions-%2B1-desc).
## 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:
```bash
git clone https://github.com/transitive-bullshit/nextjs-notion-starter-kit
cd nextjs-notion-starter-kit
yarn
```
Now that your dependencies are installed, you can run the local Next.js dev server:
```bash
yarn dev
```
You should now be able to open `http://localhost:3000` to view the webapp.
## Production
To build for production, you can run:
```bash
yarn build
```
Which just runs `next build` under the hood.
### Local-linked react-notion-x
If you are making changes to `react-notion-x` and want to test them out with `nextjs-notion-starter-kit`, you'll first need to [set up and build `react-notion-x` locally](https://github.com/NotionX/react-notion-x/blob/master/contributing.md).
Once you have `react-notion-x` set up locally, run `yarn link` from each `react-notion-x` package:
```bash
# from react-notion-x clone
cd packages/react-notion-x
yarn link
cd ../packages/notion-utils
yarn link
cd ../packages/notion-types
yarn link
cd ../packages/notion-client
yarn link
```
Now you can link these local deps into `nextjs-notion-starter-kit`:
```bash
# from nextjs-notion-starter-kit
yarn deps:link
```
The last step is to make sure that the Next.js project and these local dependencies are all pointing to the same versions of `react` and `react-dom`.
```bash
# from nextjs-notion-starter-kit
cd node_modules/react
yarn link
cd ../react-dom
yarn link
```
```bash
# from react-notion-x clone
yarn link react react-dom
```
Now, you can run `yarn dev` to keep `react-notion-x` up-to-date in one tab and in another tab, you can run `yarn dev` to keep `nextjs-notion-starter-kit` up-to-date.
### Gotchas
Whenever you make a change to one of the `react-notion-x` packages, it will automatically be recompiled into its respective `build` folder, and the `yarn dev` from `nextjs-notion-starter-kit` 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 with Next.js, try running `rm -rf .next` to refresh the Next.js cache before running `yarn dev` again.

4
readme.md
View File

@@ -131,6 +131,10 @@ To enable analytics, just add a `NEXT_PUBLIC_FATHOM_ID` environment variable, wh
Note that this feature is completely optional.
## Contributing
If you want to contribute to the project, see the [contribution guide](contributing.md) and join our amazing list of [contributors](https://github.com/transitive-bullshit/nextjs-notion-starter-kit/graphs/contributors)!
## License
MIT © [Travis Fischer](https://transitivebullsh.it)