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
[optimize] simplify Repository model & types based on MobX-GitHub
[optimize] upgrade to PNPM 9 & other latest Upstream packages
[optimize] update Read Me document
Copy file name to clipboardExpand all lines: README.md
+68-20Lines changed: 68 additions & 20 deletions
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,39 @@
2
2
3
3
[React][1] project scaffold based on [TypeScript][2], [Next.js][3], [Bootstrap][4] & [Workbox][5]. And this project bootstrapped with [`create-next-app`][6].
[][8]
8
+
[][9]
6
9
7
10
## Technology stack
8
11
9
-
- Language: [TypeScript v5][2]
12
+
- Language: [TypeScript v5][2] + [MDX v3][10]
10
13
- Component engine: [Next.js v14][3]
11
14
- Component suite: [Bootstrap v5][4]
12
15
- PWA framework: [Workbox v6][5]
13
-
- State management: [MobX v6][9]
14
-
- CI / CD: GitHub [Actions][11] + [Vercel][12]
16
+
- State management: [MobX v6][11]
17
+
- CI / CD: GitHub [Actions][12] + [Vercel][13]
18
+
- Monitor service: [Sentry][14]
19
+
20
+
## Best practice
21
+
22
+
1. Install GitHub apps in your organization or account:
23
+
24
+
1.[Probot settings][15]: set up Issue labels & Pull Request rules
25
+
2.[PR badge][16]: set up Online [VS Code][17] editor entries in Pull Request description
26
+
27
+
2. Click the **[<kbd>Use this template</kbd>][18] button** on the top of this GitHub repository's home page, then create your own repository in the app-installed namespace above
28
+
29
+
3. Click the **[<kbd>Open in GitHub codespaces</kbd>][8] button** on the top of ReadMe file, then an **online VS Code development environment** will be started immediately
30
+
31
+
4. Set [Vercel variables][19] as [Repository secrets][20], then every commit will get an independent **Preview URL**
32
+
33
+
5. Recommend to add a [Notification step in GitHub actions][21] for your Team IM app
34
+
35
+
6. Remind the PMs & users of your product to submit **Feature/Enhancement** requests or **Bug** reports with [Issue forms][22] instead of IM messages or Mobile Phone calls
36
+
37
+
7. Collect all these issues into [Project kanbans][23], then create **Pull requests** & add `closes #issue_number` into its description for automation
15
38
16
39
## Getting Started
17
40
@@ -26,26 +49,35 @@ Open http://localhost:3000 with your browser to see the result.
26
49
27
50
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
28
51
29
-
[API routes][13] can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in `pages/api/hello.ts`.
52
+
[API routes][24] can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in `pages/api/hello.ts`.
30
53
31
-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes][13] instead of React pages.
54
+
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as API routes instead of React pages.
32
55
33
56
## Learn More
34
57
35
58
To learn more about Next.js, take a look at the following resources:
36
59
37
-
-[Next.js Documentation][14] - learn about Next.js features and API.
38
-
-[Learn Next.js][15] - an interactive Next.js tutorial.
60
+
-[Next.js Documentation][25] - learn about Next.js features and API.
61
+
-[Learn Next.js][26] - an interactive Next.js tutorial.
39
62
40
-
You can check out [the Next.js GitHub repository][16] - your feedback and contributions are welcome!
63
+
You can check out [the Next.js GitHub repository][27] - your feedback and contributions are welcome!
0 commit comments