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