create-react-starter-kit 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -66
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -48,72 +48,6 @@ create-react-starter-kit -y --name my-app --dir ./apps/my-app --skip-install
|
|
|
48
48
|
- Feature-based `src/` layout + `@/` path aliases (tsconfig + bundler)
|
|
49
49
|
- `README.md` tailored to the selected stack
|
|
50
50
|
|
|
51
|
-
## Develop this package
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
git clone <repo>
|
|
55
|
-
cd create-react-starter-kit
|
|
56
|
-
npm install
|
|
57
|
-
npm run build
|
|
58
|
-
npm start
|
|
59
|
-
# or
|
|
60
|
-
node bin/create-react-starter-kit.js --defaults --name demo --dir ./tmp-generated/demo --skip-install
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
### Scripts
|
|
64
|
-
|
|
65
|
-
| Script | Purpose |
|
|
66
|
-
|--------|---------|
|
|
67
|
-
| `npm run build` | Compile TypeScript and copy templates |
|
|
68
|
-
| `npm start` | Run the CLI |
|
|
69
|
-
| `npm run validate` | Build + generate a sample project under `tmp-generated/` |
|
|
70
|
-
| `npm run typecheck` | Typecheck without emit |
|
|
71
|
-
|
|
72
|
-
### Local validation before publish
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
npm run validate
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
This generates `tmp-generated/validation-app` with default stack options and asserts key files exist. Optionally install and run that app:
|
|
79
|
-
|
|
80
|
-
```bash
|
|
81
|
-
cd tmp-generated/validation-app
|
|
82
|
-
pnpm install
|
|
83
|
-
pnpm dev
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
## Package layout
|
|
87
|
-
|
|
88
|
-
```text
|
|
89
|
-
bin/ CLI entry
|
|
90
|
-
src/ TypeScript source (prompts, generator, utils)
|
|
91
|
-
templates/ EJS templates for generated apps
|
|
92
|
-
scripts/ copy-templates + validate-cli
|
|
93
|
-
dist/ Compiled output (published)
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
Templates use `__when_<key>_<value>__/` folders and EJS conditionals so only matching configs and examples are emitted.
|
|
97
|
-
|
|
98
|
-
## Publishing to npm
|
|
99
|
-
|
|
100
|
-
1. Update `version` in `package.json` (semver).
|
|
101
|
-
2. Run `npm run validate` and smoke-test a generated app.
|
|
102
|
-
3. Ensure you are logged in: `npm login`
|
|
103
|
-
4. Publish:
|
|
104
|
-
|
|
105
|
-
```bash
|
|
106
|
-
npm publish --access public
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
5. Verify:
|
|
110
|
-
|
|
111
|
-
```bash
|
|
112
|
-
npx create-react-starter-kit@latest --help
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
See [docs/PUBLISHING.md](docs/PUBLISHING.md) for a fuller checklist.
|
|
116
|
-
|
|
117
51
|
## License
|
|
118
52
|
|
|
119
53
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-react-starter-kit",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2",
|
|
4
4
|
"description": "Interactive CLI to scaffold a production-ready React app with your preferred stack",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"typescript",
|
|
14
14
|
"generator"
|
|
15
15
|
],
|
|
16
|
-
"author": "",
|
|
16
|
+
"author": "ei-sanjay",
|
|
17
17
|
"license": "MIT",
|
|
18
18
|
"type": "module",
|
|
19
19
|
"bin": {
|
|
@@ -53,10 +53,10 @@
|
|
|
53
53
|
},
|
|
54
54
|
"repository": {
|
|
55
55
|
"type": "git",
|
|
56
|
-
"url": "git+https://github.com/
|
|
56
|
+
"url": "git+https://github.com/ei-sanjay/create-react-starter-kit.git"
|
|
57
57
|
},
|
|
58
58
|
"bugs": {
|
|
59
|
-
"url": "https://github.com/
|
|
59
|
+
"url": "https://github.com/ei-sanjay/create-react-starter-kit/issues"
|
|
60
60
|
},
|
|
61
|
-
"homepage": "https://github.com/
|
|
61
|
+
"homepage": "https://github.com/ei-sanjay/create-react-starter-kit#readme"
|
|
62
62
|
}
|