create-application-template 3.0.3 → 3.0.5
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 -129
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,129 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
> This package has moved to @epic-effx/create-application-template. Please install @epic-effx/create-application-template instead.
|
|
6
|
-
|
|
7
|
-
# Create Application Template
|
|
8
|
-
This project aims to provide a configured application template for you to build upon.
|
|
9
|
-
|
|
10
|
-
All configuration is fully visible and under your control to augment as you see fit.
|
|
11
|
-
|
|
12
|
-
The template is a typescript enabled React application with a test suite and code linting.
|
|
13
|
-
|
|
14
|
-
See the template running live [here](https://www.createapplicationtemplate.com/).
|
|
15
|
-
|
|
16
|
-
## installation
|
|
17
|
-
first install globally
|
|
18
|
-
```
|
|
19
|
-
npm install -g create-application-template@latest
|
|
20
|
-
```
|
|
21
|
-
_or_
|
|
22
|
-
```
|
|
23
|
-
npm install -g create-application-template@beta
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
then create your project
|
|
27
|
-
```
|
|
28
|
-
npx create-application-template --name={my-project}
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
## newest features 🚀
|
|
32
|
-
React 19 with [React Compiler](https://react.dev/learn/react-compiler/introduction) opt-in
|
|
33
|
-
|
|
34
|
-
this version takes advantage of the React Compiler's automatic optimization
|
|
35
|
-
|
|
36
|
-
it also includes the React Compiler's ESLint integration
|
|
37
|
-
|
|
38
|
-
## usage
|
|
39
|
-
webpack is used for code bundling and the development server
|
|
40
|
-
|
|
41
|
-
run development server and test suite (on http://localhost:3333 by default)
|
|
42
|
-
```
|
|
43
|
-
npm run dev
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
build static bundle
|
|
47
|
-
```
|
|
48
|
-
npm run build
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
## tsconfig
|
|
52
|
-
focused on type checking; babel is used for transpiling
|
|
53
|
-
|
|
54
|
-
## pre-commit
|
|
55
|
-
scripts in `.husky/pre-commit` are run on commits for quality control
|
|
56
|
-
|
|
57
|
-
add or remove scripts you'd like run before code is committed
|
|
58
|
-
|
|
59
|
-
## test suite
|
|
60
|
-
to create a test follow this file naming format: `*.{spec,test}.{ts,tsx}`
|
|
61
|
-
|
|
62
|
-
run the test suite stand alone like so
|
|
63
|
-
```
|
|
64
|
-
npm run test
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## code linting
|
|
68
|
-
linting rules are in `.eslintrc.js`; install the ESLint plugin if using vscode
|
|
69
|
-
```
|
|
70
|
-
npm run lint
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
css linting rules are in `.stylelintrc.js`; install the Stylelint plugin if using vscode
|
|
74
|
-
```
|
|
75
|
-
npm run stylelint
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
## styles
|
|
79
|
-
styling is done using the style-components module, but straight CSS is supported
|
|
80
|
-
|
|
81
|
-
after instillation it is recommended to proceed using styled-components or CSS, but not both
|
|
82
|
-
|
|
83
|
-
if you proceed with styled-components:
|
|
84
|
-
- remove the single `.css` example in `/src/styles/`
|
|
85
|
-
- that's it!
|
|
86
|
-
|
|
87
|
-
if you prefer CSS:
|
|
88
|
-
- alter `.stylelintrc.js` and `.husky/pre-commit` per the files' notes
|
|
89
|
-
- remove `.ts` files from `/src/styles/` or "recreate" them in `.css`
|
|
90
|
-
|
|
91
|
-
## environmental settings
|
|
92
|
-
access environmental variables in code like so
|
|
93
|
-
```
|
|
94
|
-
console.log(process.env.PORT)
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### `NODE_ENV` settings
|
|
98
|
-
automatically set to `production` for build; `develop` for dev server
|
|
99
|
-
|
|
100
|
-
### `.env` variables
|
|
101
|
-
add new or alter existing environmental variables via the `.env` file
|
|
102
|
-
|
|
103
|
-
the following variables exist in the default configuration and can be altered
|
|
104
|
-
|
|
105
|
-
#### develop (dev server)
|
|
106
|
-
```
|
|
107
|
-
# optional
|
|
108
|
-
PORT={port number}
|
|
109
|
-
INLINE_SIZE_LIMIT={default is 10000}
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
#### production (build)
|
|
113
|
-
```
|
|
114
|
-
# optional
|
|
115
|
-
INLINE_SIZE_LIMIT={default is 10000}
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
## dependency overrides
|
|
119
|
-
|
|
120
|
-
this version includes minimal npm `overrides` to patch known transitive vulnerabilities in webpack tooling
|
|
121
|
-
|
|
122
|
-
they are intentionally limited to patch-level upgrades within the same major
|
|
123
|
-
|
|
124
|
-
you can remove them in the future by:
|
|
125
|
-
|
|
126
|
-
1. running `npm update`
|
|
127
|
-
2. removing the `overrides` section
|
|
128
|
-
3. reinstalling dependencies
|
|
129
|
-
4. running `npm audit`
|