You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 12, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+29-13
Original file line number
Diff line number
Diff line change
@@ -1,20 +1,25 @@
1
1
# Contributing
2
2
3
-
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).
3
+
Suggestions and pull requests are highly encouraged. Have a look at the
Now that your dependencies are installed, you can run the local Next.js dev server:
21
+
Now that your dependencies are installed, you can run the local Next.js dev
22
+
server:
18
23
19
24
```bash
20
25
yarn dev
@@ -34,9 +39,12 @@ Which just runs `next build` under the hood.
34
39
35
40
### Local-linked react-notion-x
36
41
37
-
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).
42
+
If you are making changes to `react-notion-x` and want to test them out with
43
+
`powerium.io`, you'll first need to
44
+
[set up and build `react-notion-x` locally](https://github.com/NotionX/react-notion-x/blob/master/contributing.md).
38
45
39
-
Once you have `react-notion-x` set up locally, run `yarn link` from each `react-notion-x` package:
46
+
Once you have `react-notion-x` set up locally, run `yarn link` from each
47
+
`react-notion-x` package:
40
48
41
49
```bash
42
50
# from react-notion-x clone
@@ -50,14 +58,15 @@ cd ../packages/notion-client
50
58
yarn link
51
59
```
52
60
53
-
Now you can link these local deps into `nextjs-notion-starter-kit`:
61
+
Now you can link these local deps into `powerium.io`:
54
62
55
63
```bash
56
64
# from nextjs-notion-starter-kit
57
65
yarn deps:link
58
66
```
59
67
60
-
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`.
68
+
The last step is to make sure that the Next.js project and these local
69
+
dependencies are all pointing to the same versions of `react` and `react-dom`.
61
70
62
71
```bash
63
72
# from react-notion-x clone
@@ -72,12 +81,19 @@ yarn link
72
81
yarn link react react-dom
73
82
```
74
83
75
-
With this setup, in one tab, you can run `yarn dev` to keep `react-notion-x` up-to-date, and in another tab, you can run `yarn dev` to keep `nextjs-notion-starter-kit` up-to-date.
84
+
With this setup, in one tab, you can run `yarn dev` to keep `react-notion-x`
85
+
up-to-date, and in another tab, you can run `yarn dev` to keep `powerium.io`
86
+
up-to-date.
76
87
77
88
### Gotchas
78
89
79
-
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.
90
+
Whenever you make a change to one of the `react-notion-x` packages, it will
91
+
automatically be recompiled into its respective `build` folder, and the
92
+
`yarn dev` from `powerium.io` should hot-reload it in the browser.
80
93
81
-
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.
94
+
Sometimes, this process gets a little out of whack, and if you're not sure
95
+
what's going on, I usually just quit one or both of the `yarn dev` commands and
96
+
restart them.
82
97
83
-
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.
98
+
If you're seeing something unexpected while debugging with Next.js, try running
99
+
`rm -rf .next` to refresh the Next.js cache before running `yarn dev` again.
0 commit comments