Skip to content

Commit 6eecda9

Browse files
committed
chore: test and docs config
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
1 parent f67c643 commit 6eecda9

5 files changed

Lines changed: 36 additions & 1 deletion

File tree

docs/setup/Macbook_setup.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,16 @@ pnpm dev
3737
```
3838
Access the site: Once the command is running, open your browser to http://localhost:3000/
3939

40+
Both `pnpm dev` and `pnpm build` first run `pnpm sync:data`, which fetches
41+
repository statistics from the GitHub API. Anonymous requests are rate-limited,
42+
and when the limit is hit the sync quietly falls back to the JSON caches
43+
committed in `src/data/`. To keep the numbers fresh during repeated local
44+
builds, export a GitHub token first:
45+
46+
```
47+
export GITHUB_TOKEN=<your personal access token>
48+
```
49+
4050
Step 5: Building for Production
4151

4252
To generate the production-ready application build:

docs/setup/linux_setup.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ Open your browser and visit:
3333

3434
http://localhost:3000/
3535

36+
Both `pnpm dev` and `pnpm build` first run `pnpm sync:data`, which fetches
37+
repository statistics from the GitHub API. Anonymous requests are rate-limited,
38+
and when the limit is hit the sync quietly falls back to the JSON caches
39+
committed in `src/data/`. To keep the numbers fresh during repeated local
40+
builds, export a GitHub token first:
41+
42+
export GITHUB_TOKEN=<your personal access token>
43+
3644
## Step 5: Preview Draft Content
3745

3846
To preview draft blog posts, just ensure the `draft` flag in your markdown front matter is respected by your application logic, and run:

docs/setup/windows_setup.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@ ready - started server on 0.0.0.0:3000, url: http://localhost:3000
3636

3737
Open `http://localhost:3000` to see the project.
3838

39+
Both `pnpm dev` and `pnpm build` first run `pnpm sync:data`, which fetches
40+
repository statistics from the GitHub API. Anonymous requests are rate-limited,
41+
and when the limit is hit the sync quietly falls back to the JSON caches
42+
committed in `src/data/`. To keep the numbers fresh during repeated local
43+
builds, set a GitHub token first:
44+
45+
```powershell
46+
$env:GITHUB_TOKEN = "<your personal access token>"
47+
```
48+
3949
You have just set up the Hiero-Website locally!
4050

4151
### Run Build Command

e2e/tsconfig.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"extends": "../tsconfig.json",
3+
"compilerOptions": {
4+
"incremental": false
5+
},
6+
"include": ["./**/*.ts", "../playwright.config.ts"]
7+
}

tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,5 +33,5 @@
3333
".next/dev/types/**/*.ts",
3434
"**/*.mts"
3535
],
36-
"exclude": ["node_modules"]
36+
"exclude": ["node_modules", "e2e", "playwright.config.ts"]
3737
}

0 commit comments

Comments
 (0)