Skip to content
This repository was archived by the owner on Nov 12, 2024. It is now read-only.

Commit 43b38ee

Browse files
committed
Tweak config for powerium.io
1 parent 3bda661 commit 43b38ee

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+909
-817
lines changed

.github/funding.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
github: [transitive-bullshit]
1+
github: powersagitar

.github/workflows/build.yml

-22
This file was deleted.

.prettierrc

+10-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,14 @@
1616
],
1717
"importOrderSeparation": true,
1818
"importOrderSortSpecifiers": true,
19-
"importOrderGroupNamespaceSpecifiers": true
19+
"importOrderGroupNamespaceSpecifiers": true,
20+
"overrides": [
21+
{
22+
"files": "*.md",
23+
"options": {
24+
"printWidth": 80,
25+
"proseWrap": "always"
26+
}
27+
}
28+
]
2029
}

.vscode/settings.json

+35-26
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,46 @@
11
{
2-
"typescript.tsdk": "./node_modules/typescript/lib",
2+
"[css]": {
3+
"editor.defaultFormatter": "esbenp.prettier-vscode"
4+
},
5+
"[markdown]": {
6+
"editor.defaultFormatter": "esbenp.prettier-vscode"
7+
},
8+
"[typescript]": {
9+
"editor.defaultFormatter": "esbenp.prettier-vscode"
10+
},
311
"files.exclude": {
4-
"**/logs": true,
512
"**/*.log": true,
6-
"**/npm-debug.log*": true,
7-
"**/yarn-debug.log*": true,
8-
"**/yarn-error.log*": true,
9-
"**/pids": true,
1013
"**/*.pid": true,
11-
"**/*.seed": true,
1214
"**/*.pid.lock": true,
15+
"**/*.seed": true,
16+
"**/*.tgz": true,
1317
"**/.dummy": true,
14-
"**/lib-cov": true,
15-
"**/coverage": true,
16-
"**/.nyc_output": true,
18+
"**/.eslintcache": true,
19+
"**/.google.json": true,
1720
"**/.grunt": true,
18-
"**/.snapshots/": true,
19-
"**/bower_components": true,
2021
"**/.lock-wscript": true,
21-
"build/Release": true,
22-
"**/node_modules/": true,
23-
"**/jspm_packages/": true,
24-
"**/typings/": true,
25-
"**/.npm": true,
26-
"**/.eslintcache": true,
27-
"**/.node_repl_history": true,
28-
"**/*.tgz": true,
29-
"**/.yarn-integrity": true,
3022
"**/.next/": true,
31-
"**/dist/": true,
32-
"**/build/": true,
23+
"**/.node_repl_history": true,
3324
"**/.now/": true,
25+
"**/.npm": true,
26+
"**/.nyc_output": true,
27+
"**/.snapshots/": true,
3428
"**/.vercel/": true,
35-
"**/.google.json": true
36-
}
37-
}
29+
"**/.yarn-integrity": true,
30+
"**/bower_components": true,
31+
"**/build/": true,
32+
"**/coverage": true,
33+
"**/dist/": true,
34+
"**/jspm_packages/": true,
35+
"**/lib-cov": true,
36+
"**/logs": true,
37+
"**/node_modules/": true,
38+
"**/npm-debug.log*": true,
39+
"**/pids": true,
40+
"**/typings/": true,
41+
"**/yarn-debug.log*": true,
42+
"**/yarn-error.log*": true,
43+
"build/Release": true
44+
},
45+
"typescript.tsdk": "./node_modules/typescript/lib"
46+
}

contributing.md renamed to CONTRIBUTING.md

+29-13
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,25 @@
11
# Contributing
22

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
4+
[open issues](https://github.com/NotionX/react-notion-x/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc),
5+
especially
6+
[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).
47

58
## Development
69

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

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

1115
```bash
12-
git clone https://github.com/transitive-bullshit/nextjs-notion-starter-kit
13-
cd nextjs-notion-starter-kit
16+
git clone https://github.com/powerium/powerium.io
17+
cd powerium.io
1418
yarn
1519
```
1620

17-
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:
1823

1924
```bash
2025
yarn dev
@@ -34,9 +39,12 @@ Which just runs `next build` under the hood.
3439

3540
### Local-linked react-notion-x
3641

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).
3845

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:
4048

4149
```bash
4250
# from react-notion-x clone
@@ -50,14 +58,15 @@ cd ../packages/notion-client
5058
yarn link
5159
```
5260

53-
Now you can link these local deps into `nextjs-notion-starter-kit`:
61+
Now you can link these local deps into `powerium.io`:
5462

5563
```bash
5664
# from nextjs-notion-starter-kit
5765
yarn deps:link
5866
```
5967

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`.
6170

6271
```bash
6372
# from react-notion-x clone
@@ -72,12 +81,19 @@ yarn link
7281
yarn link react react-dom
7382
```
7483

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.
7687

7788
### Gotchas
7889

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.
8093

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.
8297

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

Comments
 (0)