chayns-toolkit 3.0.1 → 3.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.
Files changed (3) hide show
  1. package/README.md +88 -70
  2. package/lib/cli.js +12 -12
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,70 +1,88 @@
1
- <div align="center">
2
- <a href="https://tobitsoftware.github.io/chayns-toolkit/" target="_blank">
3
- <h1 align="center">
4
- <img src="https://raw.githubusercontent.com/TobitSoftware/chayns-toolkit/HEAD/assets/logo.png" width="500px" alt="chayns-toolkit" />
5
- </h1>
6
- </a>
7
- <p align="center">A zero-config toolchain for developing chayns® apps.</p>
8
- <p align="center">
9
- <a href="https://github.com/TobitSoftware/chayns-toolkit/blob/master/LICENSE" target="_blank">
10
- <img src="https://img.shields.io/github/license/TobitSoftware/chayns-toolkit?color=%23A855F7&labelColor=%2327272A&style=for-the-badge" alt="" />
11
- </a>
12
- <a href="https://www.npmjs.com/package/chayns-toolkit" target="_blank">
13
- <img src="https://img.shields.io/npm/v/chayns-toolkit?color=%236366F1&labelColor=%2327272A&style=for-the-badge" alt="" />
14
- </a>
15
- <a href="https://github.com/TobitSoftware/chayns-toolkit/branches" target="_blank">
16
- <img src="https://img.shields.io/github/last-commit/TobitSoftware/chayns-toolkit?color=%2310B981&labelColor=%2327272A&style=for-the-badge" alt="" />
17
- </a>
18
- </p>
19
- </div>
20
-
21
- ---
22
-
23
- **chayns-toolkit** contains pre-configured tools for the development, publishing
24
- and quality assurance of your app. It was created to simplify the development
25
- experience when working with [React](https://reactjs.org).
26
-
27
- > This toolchain is specialized in developing apps and plugins for the
28
- > [chayns®](https://chayns.org/) platform. If you want to develop a general
29
- > purpose web app, take a look at [Next.js](https://nextjs.org/). <br>
30
-
31
- <br>
32
-
33
- ## ❯ Getting Started
34
-
35
- For the easiest way to start a new chayns® project with chayns-toolkit check out
36
- [`create-chayns-app`](https://github.com/TobitSoftware/create-chayns-app).
37
-
38
- <br>
39
-
40
- ## ❯ Documentation
41
-
42
- Visit
43
- [https://tobitsoftware.github.io/chayns-toolkit/](https://tobitsoftware.github.io/chayns-toolkit/)
44
- to view the full documentation.
45
-
46
- <br>
47
-
48
- ## ❯ Contributing
49
-
50
- Please see our
51
- [contributing document](https://tobitsoftware.github.io/chayns-toolkit/docs/contributing).
52
-
53
- <br>
54
-
55
- ---
56
-
57
- <p align="center">
58
- <sub>
59
- Project created by Leo Driesch at Tobit.Software.
60
- </sub>
61
- </p>
62
- <p align="center">
63
- <a href="https://labs.tobit.com/">
64
- <img alt="Tobit.Software homepage" src="./assets/icons/globe.svg">
65
- </a>
66
- &nbsp;&nbsp;
67
- <a href="https://github.com/TobitSoftware">
68
- <img alt="Tobit.Software on GitHub" src="./assets/icons/github.svg">
69
- </a>
70
- </p>
1
+ <div align="center">
2
+ <a href="https://tobitsoftware.github.io/chayns-toolkit/" target="_blank">
3
+ <h1 align="center">
4
+ <img src="https://raw.githubusercontent.com/TobitSoftware/chayns-toolkit/HEAD/assets/logo.png" width="500px" alt="chayns-toolkit" />
5
+ </h1>
6
+ </a>
7
+ <p align="center">A zero-config toolchain for developing chayns® apps.</p>
8
+ <p align="center">
9
+ <a href="https://github.com/TobitSoftware/chayns-toolkit/blob/master/LICENSE" target="_blank">
10
+ <img src="https://img.shields.io/github/license/TobitSoftware/chayns-toolkit?color=%23A855F7&labelColor=%2327272A&style=for-the-badge" alt="" />
11
+ </a>
12
+ <a href="https://www.npmjs.com/package/chayns-toolkit" target="_blank">
13
+ <img src="https://img.shields.io/npm/v/chayns-toolkit?color=%236366F1&labelColor=%2327272A&style=for-the-badge" alt="" />
14
+ </a>
15
+ <a href="https://github.com/TobitSoftware/chayns-toolkit/branches" target="_blank">
16
+ <img src="https://img.shields.io/github/last-commit/TobitSoftware/chayns-toolkit?color=%2310B981&labelColor=%2327272A&style=for-the-badge" alt="" />
17
+ </a>
18
+ </p>
19
+ </div>
20
+
21
+ ---
22
+
23
+ **chayns-toolkit** contains pre-configured tools for the development, publishing and quality
24
+ assurance of your app. It was created to simplify the development experience when working with
25
+ [React](https://reactjs.org).
26
+
27
+ > This toolchain is specialized in developing apps and plugins for the
28
+ > [chayns®](https://chayns.org/) platform. If you want to develop a general purpose web app, take a
29
+ > look at [Next.js](https://nextjs.org/). <br>
30
+
31
+ <br>
32
+
33
+ ## ❯ Getting Started
34
+
35
+ For the easiest way to start a new chayns® project with chayns-toolkit check out
36
+ [`create-chayns-app`](https://github.com/TobitSoftware/create-chayns-app).
37
+
38
+ <br>
39
+
40
+ ## ❯ Documentation
41
+
42
+ Visit
43
+ [https://tobitsoftware.github.io/chayns-toolkit/](https://tobitsoftware.github.io/chayns-toolkit/)
44
+ to view the full documentation.
45
+
46
+ <br>
47
+
48
+ ## ❯ Migration v2 to v3
49
+
50
+ The chayns-toolkit moved RsBuild instead of webpack in this version. This means customizing the
51
+ config has changed significantly.
52
+
53
+ - **output.apiVersion** has been removed
54
+ - **remoteEntry.js** has been renamed to **v2.remoteEntry.js**
55
+ - **output.serverSideRendering** has been added. This creates a build to use for modules in SSR.
56
+ - Creates two subdirectories in build directory for client- and server-build.
57
+ - dotenv-Files will be automatically loaded now depending on the current NODE_ENV/BUILD_ENV
58
+ - Only variables which start with PUBLIC\_ are passed to the javascript context. Other
59
+ variables are only available in the toolkit.config.js to customize the config
60
+ - Not defined environment-variables are not replaced by RsBuild which can cause errors (webpack
61
+ replaced them with empty string)
62
+ - **output.entryPoints** has been added and changes how to configure the entry points of the
63
+ application
64
+ [https://tobitsoftware.github.io/chayns-toolkit/docs/configuration/output](https://tobitsoftware.github.io/chayns-toolkit/docs/configuration/output)
65
+
66
+ ## ❯ Contributing
67
+
68
+ Please see our
69
+ [contributing document](https://tobitsoftware.github.io/chayns-toolkit/docs/contributing).
70
+
71
+ <br>
72
+
73
+ ---
74
+
75
+ <p align="center">
76
+ <sub>
77
+ Project created by Leo Driesch at Tobit.Software.
78
+ </sub>
79
+ </p>
80
+ <p align="center">
81
+ <a href="https://labs.tobit.com/">
82
+ <img alt="Tobit.Software homepage" src="./assets/icons/globe.svg">
83
+ </a>
84
+ &nbsp;&nbsp;
85
+ <a href="https://github.com/TobitSoftware">
86
+ <img alt="Tobit.Software on GitHub" src="./assets/icons/github.svg">
87
+ </a>
88
+ </p>