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
> [Featured packages built with this template.](./FEATURED.md)
6
6
@@ -32,25 +32,42 @@ This template offers following pre-configured features. Additionally, your repo
32
32
33
33
✅ Workflow to automatically publish and create a GitHub release when you update your librari's `package.json` file.
34
34
35
-
✅ Workflow to automatically rebrand entire template based on the name of the repo you create from this template. (As soon as you create a repo from this template, setup workflow is triggered which renames @mayank1513/fork-me to your repo name and does lots of other fixes to set you up and running.)
35
+
✅ Workflow to automatically rebrand entire template based on the name of the repo you create from this template. (As soon as you create a repo from this template, setup workflow is triggered which renames esbuild-plugin-react18-css to your repo name and does lots of other fixes to set you up and running.)
36
36
37
37
✅ With all these features, this readme file contains a quick checklist for you to configure Codecov and other badges, setup your docs website on GitHub pages, etc. See [Checklist](#step-by-step-instructions-and-checklist).
38
38
39
39
#### Create a library that is
40
40
41
-
✅ Fully Treeshakable (import from @mayank1513/fork-me/client/component)
41
+
✅ Fully Treeshakable (import from esbuild-plugin-react18-css/client/component)
42
42
43
43
✅ Full TypeScript Support
44
44
45
45
✅ Unleash the full power of React18 Server components
46
46
47
47
✅ Works with all build systems/tools/frameworks for React18
48
48
49
-
✅ Doccumented with [Typedoc](https://react18-tools.github.io/turborepo-template) ([Docs](https://react18-tools.github.io/turborepo-template))
49
+
✅ Doccumented with [Typedoc](https://react18-tools.github.io/esbuild-plugin-react18-css) ([Docs](https://react18-tools.github.io/esbuild-plugin-react18-css))
50
+
51
+
## Install
52
+
53
+
```bash
54
+
$ pnpm add esbuild-plugin-react18-css
55
+
```
56
+
57
+
or
58
+
59
+
```bash
60
+
$ npm install esbuild-plugin-react18-css
61
+
```
62
+
63
+
or
64
+
65
+
```bash
66
+
$ yarn add esbuild-plugin-react18-css
67
+
```
68
+
50
69
51
-
## Introduction
52
70
53
-
This template is based on the official starter Turborepo but with additional features tailored for creating and publishing JavaScript/TypeScript and specifically React18 libraries.
54
71
55
72
## Getting started:
56
73
@@ -70,11 +87,11 @@ Compared to the default scaffold from create-turbo, this template offers:
70
87
71
88
## Step by Step Instructions and Checklist
72
89
73
-
-[ ] Star [this repo](https://github.com/react18-tools/turborepo-template/) so that you and others can find it more easily for your next projects. It also helps me understand that people are using this repo so that I can maintain the repo and the documentation well.
74
-
-[ ] Craete new GitHub repository using this template.
75
-
-[ ] Click `Use this template` button on top right -> `Create a new repository`
76
-
-[ ] Set your library name as repository name (This template has automation workflows to customize your repo assuming repo name as library name.)
77
-
-[ ] Click `Create repository` and wait for the setup workflow to finish rebranding your repo.
90
+
-[ ] Star [this repo](https://github.com/react18-tools/esbuild-plugin-react18-css/) so that you and others can find it more easily for your next projects. It also helps me understand that people are using this repo so that I can maintain the repo and the documentation well.
91
+
92
+
93
+
94
+
78
95
-[ ] Install and setup Node.js and IDE (I prefer VSCode)
@@ -89,21 +106,21 @@ Compared to the default scaffold from create-turbo, this template offers:
89
106
-[ ] Please make sure `owner` is set to your <npmjs.com> username before running the above command.
90
107
-[ ] Set up `CodeCov`
91
108
-[ ] Visit codecov and setup your repo
92
-
-[ ] Create [repository secret](https://github.com/react18-tools/turborepo-template/settings/secrets/actions) for `CODECOV_TOKEN`
109
+
-[ ] Create [repository secret](https://github.com/react18-tools/esbuild-plugin-react18-css/settings/secrets/actions) for `CODECOV_TOKEN`
93
110
-[ ] Set up `CodeClimate`
94
111
-[ ] Visit CodeClimate and setup your repo
95
-
-[ ] Create [repository secret](https://github.com/react18-tools/turborepo-template/settings/secrets/actions) for `CC_TEST_REPORTER_ID`
112
+
-[ ] Create [repository secret](https://github.com/react18-tools/esbuild-plugin-react18-css/settings/secrets/actions) for `CC_TEST_REPORTER_ID`
96
113
-[ ] add `*.test.*` to ignore patterns on the website
97
114
-[ ] update code climate badge
98
115
-[ ] Add `NPM_AUTH_TOKEN` to repository secrets to automate publishing package
99
116
-[ ] login to your [`npm` account](https://www.npmjs.com/login) and create automation token
100
117
-[ ] Create a new repository secrets `NPM_AUTH_TOKEN`
101
-
-[ ] Update description in `lib/@mayank1513/fork-me/package.json`
118
+
-[ ] Update description in `lib/esbuild-plugin-react18-css/package.json`
102
119
-[ ] Update Repo Stats by visiting and setting up [repobeats](https://repobeats.axiom.co/)
103
120
-[ ] Create your library and update examples
104
121
-[ ] Update README
105
122
-[ ] Setup GitHub pages to deploy docs
106
-
-[ ] Go to [repo settings](https://github.com/react18-tools/turborepo-template/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
123
+
-[ ] Go to [repo settings](https://github.com/react18-tools/esbuild-plugin-react18-css/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
107
124
-[ ] Push your changes/Create PR and see your library being automatically tested and published
108
125
-[ ] Optionally deploy your example(s) to Vercel.
109
126
-[ ] Update sponsorship urls.
@@ -140,7 +157,7 @@ Each package/example is 100% [TypeScript](https://www.typescriptlang.org/).
140
157
To build all apps and packages, run the following command:
141
158
142
159
```
143
-
cd my-turborepo
160
+
cd esbuild-plugin-react18-css
144
161
pnpm build
145
162
```
146
163
@@ -149,7 +166,7 @@ pnpm build
149
166
To develop all apps and packages, run the following command:
150
167
151
168
```
152
-
cd my-turborepo
169
+
cd esbuild-plugin-react18-css
153
170
pnpm dev
154
171
```
155
172
@@ -164,7 +181,7 @@ Learn more about the power of Turborepo:
Want hands-on course for getting started with Turborepo? Check out [React and Next.js with TypeScript](https://mayank-chaudhari.vercel.app/courses/react-and-next-js-with-typescript) and [The Game of Chess with Next.js, React and TypeScrypt](https://www.udemy.com/course/game-of-chess-with-nextjs-react-and-typescrypt/?referralCode=851A28F10B254A8523FE)
0 commit comments