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
Copy file name to clipboardExpand all lines: README.md
-18Lines changed: 0 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,14 +18,10 @@ The goal of this template is to simplify the process of creating, maintaining, a
18
18
19
19
Using this library is straightforward:
20
20
21
-
---
22
-
23
21
### 1. Create a repository
24
22
25
23
Click the **[Use this template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)** button to create a new repository based on this template.
26
24
27
-
---
28
-
29
25
### 2. Configure `npm` authentication
30
26
31
27
Create an **`NPM_TOKEN` repository secret** in your new repository. The token must be a valid [npm access token](https://docs.npmjs.com/creating-and-viewing-access-tokens) with **read and write permissions**. On top of that, it must **bypass 2FA**, as it is used in a *CD* workflow.
@@ -36,8 +32,6 @@ Create an **`NPM_TOKEN` repository secret** in your new repository. The token mu
36
32
> [!NOTE]
37
33
> This token is required by the [automated release workflow](./.github/workflows/release.yml).
38
34
39
-
---
40
-
41
35
### 3. Update `package.json`
42
36
43
37
Edit the [package.json](./package.json) file to reflect your library’s metadata:
@@ -51,8 +45,6 @@ Edit the [package.json](./package.json) file to reflect your library’s metadat
51
45
-`homepage` – Project homepage (e.g. the README)
52
46
-`keywords` – Relevant keywords for discoverability
53
47
54
-
---
55
-
56
48
### 4. Install dependencies and start development
57
49
58
50
Execute the following commands:
@@ -62,8 +54,6 @@ npm install
62
54
npm run dev
63
55
```
64
56
65
-
---
66
-
67
57
### 5. Develop your library
68
58
69
59
This template comes with sample code inside the [`src` folder](./src).
@@ -82,8 +72,6 @@ On top of that, every commit must follow this [Conventional Commits](https://www
82
72
> [!NOTE]
83
73
> This is required by the [release workflow, which analyzes every commit to automatically generate the releases](./.github/workflows/release.yml).
84
74
85
-
---
86
-
87
75
### 6. Validate locally using the dev site
88
76
89
77
This template includes a local development site under the [`dev folder`](./dev).
@@ -92,8 +80,6 @@ Remove the `dependencies` from the [`package.json`](./dev/package.json), and exe
92
80
93
81
Update the [sample code](./dev/index.html) and visit `http://localhost:5173/dev/` to check the implementation.
94
82
95
-
---
96
-
97
83
### 7. Build a demo site
98
84
99
85
A sample [Next.js](https://nextjs.org/) demo site is included in the [`www folder`](./www).
@@ -107,17 +93,13 @@ Then, you can update the [sample code](./www/app) and visit `http://localhost:30
107
93
108
94
Finally, remember to [enable GitHub Pages with GitHub Actions for your repository](http://localhost:3000/lib-ts-react-template).
109
95
110
-
---
111
-
112
96
### 8. Finalize documentation
113
97
114
98
Update the [`README.md`](./README.md) to describe your library’s purpose and usage.
115
99
116
100
> [!IMPORTANT]
117
101
> Don’t forget to update the release badge URL at the top of this file if you keep it — it currently points to this repository.
118
102
119
-
---
120
-
121
103
> [!NOTE]
122
104
> To gain a deeper understanding of how to use this library and how it works under the hood, visit the [wiki page](https://github.com/d3p1/lib-ts-react-template/wiki).
0 commit comments