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
@@ -34,25 +34,42 @@ This template offers following pre-configured features. Additionally, your repo
34
34
35
35
✅ Workflow to automatically publish and create a GitHub release when you update your librari's `package.json` file.
36
36
37
-
✅ 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.)
37
+
✅ 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 fork-me to your repo name and does lots of other fixes to set you up and running.)
38
38
39
39
✅ 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).
40
40
41
41
#### Create a library that is
42
42
43
-
✅ Fully Treeshakable (import from @mayank1513/fork-me/client/component)
43
+
✅ Fully Treeshakable (import from fork-me/client/component)
44
44
45
45
✅ Full TypeScript Support
46
46
47
47
✅ Unleash the full power of React18 Server components
48
48
49
49
✅ Works with all build systems/tools/frameworks for React18
50
50
51
-
✅ Doccumented with [Typedoc](https://react18-tools.github.io/turborepo-template) ([Docs](https://react18-tools.github.io/turborepo-template))
51
+
✅ Doccumented with [Typedoc](https://react18-tools.github.io/fork-me) ([Docs](https://react18-tools.github.io/fork-me))
52
+
53
+
## Install
54
+
55
+
```bash
56
+
$ pnpm add fork-me
57
+
```
58
+
59
+
or
60
+
61
+
```bash
62
+
$ npm install fork-me
63
+
```
64
+
65
+
or
66
+
67
+
```bash
68
+
$ yarn add fork-me
69
+
```
70
+
52
71
53
-
## Introduction
54
72
55
-
This template is based on the official starter Turborepo but with additional features tailored for creating and publishing JavaScript/TypeScript and specifically React18 libraries.
56
73
57
74
## Getting started:
58
75
@@ -72,11 +89,11 @@ Compared to the default scaffold from create-turbo, this template offers:
72
89
73
90
## Step by Step Instructions and Checklist
74
91
75
-
-[ ] 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.
76
-
-[ ] Craete new GitHub repository using this template.
77
-
-[ ] Click `Use this template` button on top right -> `Create a new repository`
78
-
-[ ] Set your library name as repository name (This template has automation workflows to customize your repo assuming repo name as library name.)
79
-
-[ ] Click `Create repository` and wait for the setup workflow to finish rebranding your repo.
92
+
-[ ] Star [this repo](https://github.com/react18-tools/fork-me/) 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.
93
+
94
+
95
+
96
+
80
97
-[ ] Install and setup Node.js and IDE (I prefer VSCode)
@@ -91,27 +108,27 @@ Compared to the default scaffold from create-turbo, this template offers:
91
108
-[ ] Please make sure `owner` is set to your <npmjs.com> username before running the above command.
92
109
-[ ] Set up `CodeCov`
93
110
-[ ] Visit codecov and setup your repo
94
-
-[ ] Create [repository secret](https://github.com/react18-tools/turborepo-template/settings/secrets/actions) for `CODECOV_TOKEN`
111
+
-[ ] Create [repository secret](https://github.com/react18-tools/fork-me/settings/secrets/actions) for `CODECOV_TOKEN`
95
112
-[ ] Set up `CodeClimate`
96
113
-[ ] Visit CodeClimate and setup your repo
97
-
-[ ] Create [repository secret](https://github.com/react18-tools/turborepo-template/settings/secrets/actions) for `CC_TEST_REPORTER_ID`
114
+
-[ ] Create [repository secret](https://github.com/react18-tools/fork-me/settings/secrets/actions) for `CC_TEST_REPORTER_ID`
98
115
-[ ] add `*.test.*` to ignore patterns on the website
99
116
-[ ] update code climate badge
100
117
-[ ] Add `NPM_AUTH_TOKEN` to repository secrets to automate publishing package
101
118
-[ ] login to your [`npm` account](https://www.npmjs.com/login) and create automation token
102
119
-[ ] Create a new repository secrets `NPM_AUTH_TOKEN`
103
-
-[ ] Update description in `lib/@mayank1513/fork-me/package.json`
120
+
-[ ] Update description in `lib/fork-me/package.json`
104
121
-[ ] Update Repo Stats by visiting and setting up [repobeats](https://repobeats.axiom.co/)
105
122
-[ ] Create your library and update examples
106
123
-[ ] Update README
107
124
-[ ] Setup GitHub pages to deploy docs
108
-
-[ ] 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`
125
+
-[ ] Go to [repo settings](https://github.com/react18-tools/fork-me/settings/pages) -> pages (On left panel); Select deploy from a branch; Then Select `main` and `/docs`
109
126
-[ ] (Optional) Set up [Deepsource](https://app.deepsource.com/login) for static code analysis
110
127
-[ ] Push your changes/Create PR and see your library being automatically tested and published
111
128
-[ ] Optionally deploy your example(s) to Vercel.
112
129
-[ ] Update sponsorship urls.
113
-
-[ ] You are most welcome to star this template, contribute, and/or sponsor the `terbo-repo-template` project or my other open-source work
114
-
-[ ] You can also fork the [`terbo-repo-template`](https://github.com/react18-tools/turbo-repo-template/fork) and add your package to `packages/shared-ui/src/examples/featured.json`
130
+
-[ ] You are most welcome to star this template, contribute, and/or sponsor the `terborepo-template` project or my other open-source work
131
+
-[ ] You can also fork the [`terborepo-template`](https://github.com/react18-tools/turbo-repo-template/fork) and add your package to `packages/shared-ui/src/examples/featured.json`
115
132
-[ ] If approved your package will be automatically added to FEATURED.md and also published on the home page of this repo.
116
133
117
134
## What's inside?
@@ -143,7 +160,7 @@ Each package/example is 100% [TypeScript](https://www.typescriptlang.org/).
143
160
To build all apps and packages, run the following command:
144
161
145
162
```
146
-
cd my-turborepo
163
+
cd fork-me
147
164
pnpm build
148
165
```
149
166
@@ -152,7 +169,7 @@ pnpm build
152
169
To develop all apps and packages, run the following command:
153
170
154
171
```
155
-
cd my-turborepo
172
+
cd fork-me
156
173
pnpm dev
157
174
```
158
175
@@ -167,7 +184,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