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
Copy file name to clipboardExpand all lines: apps/demos/README.md
+27-26Lines changed: 27 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,65 +1,68 @@
1
1
# DevExtreme Demos
2
2
3
-
This repository contains technical DevExtreme demos for Angular, React, Vue, jQuery, ASP.NET MVC, and ASP.NET Core.
3
+
This repository contains technical DevExtreme demos for Angular, React, Vue, and jQuery.
4
4
5
5
To run the demos on your machine, clone this repository, run `pnpm install`, and follow the instructions below.
6
6
7
7
## Prepare Demos for Development
8
-
Before running you need execute in `monorepo/root`:
9
8
10
-
```
11
-
pnpm run all:build-dev
12
-
```
9
+
### Run demos locally
13
10
14
-
To prepare demos for development:
11
+
In `monorepo/root`
15
12
13
+
Build all dependencies and prepare systemJS configs by executing:
16
14
```
17
-
pnpm run prepare-js
15
+
pnpm run demos:prepare
18
16
```
19
17
20
-
Angular, Vue, and React demos can use bundles instead of separate files from `node_modules`. With bundles, demos launch faster but become harder to debug. Run the following command to create the bundles and replace the SystemJS configuration:
21
-
18
+
Start webserver:
22
19
```
23
-
pnpm run prepare-bundles
20
+
pnpm run demos:start
24
21
```
22
+
Navigate to http://localhost:8080/.
23
+
24
+
You can pass additional parameter to specify port. It can be useful when you need to fast switching between one demo on different frameworks.
25
+
25
26
26
-
To return to using separate files from `node_modules`, run `pnpm run prepare-js`.
27
+
### Bundled mode
27
28
29
+
Angular, Vue, and React demos can use bundles instead of separate files from `node_modules`. With bundles, demos launch faster but become harder to debug.
28
30
29
-
### Launch
31
+
In `apps/demos`
32
+
33
+
Run the following command to create the bundles and replace the SystemJS configuration:
30
34
31
-
#### Option 1
32
35
```
33
-
pnpm run launch-demo
36
+
pnpm run prepare-bundles
34
37
```
35
38
36
-
#### Option 2
37
-
1. Run ```pnpm run webserver ``` from `monorepo/root`
38
-
2. Navigate to http://localhost:8080/apps/demos.
39
+
To return to using separate files from `node_modules`, run:
39
40
40
-
You can pass additional parameter to specify port. It can be useful when you need to fast switching between one demo on different frameworks:
41
+
```
42
+
pnpm run prepare-js
43
+
```
41
44
42
-
### Before Commiting Сhanges
45
+
### Before Commiting Changes
43
46
44
-
For fix autofixed errors:
47
+
Auto-fix lint errors:
45
48
46
49
```
47
50
pnpm run fix-lint
48
51
```
49
52
50
-
### Development
53
+
### Adding new demo
51
54
52
55
1. Run the following script to add a new demo:
53
56
54
57
```
55
58
pnpm run add-demo
56
59
```
57
60
58
-
1. Use the built-in CLI to choose or enter the category, the demo name, and the technology for the new demo.
61
+
2. Use the built-in CLI to choose or enter the category, the demo name, and the technology for the new demo.
59
62
60
63
### TS React Infrastructure
61
64
62
-
1. After you make any changes in React TypeScript sources, run the following command:
65
+
After you make any changes in React TypeScript sources, run the following command:
63
66
64
67
```
65
68
pnpm run convert-to-js split
@@ -71,9 +74,7 @@ If you want to run this script on specific folder you can pass it to the argumen
71
74
pnpm run convert-to-js "JSDemos/Demos/Diagram/**/React"
72
75
```
73
76
74
-
1. To ensure that React JavaScript and TypeScript sources are always in sync, the following GitHub action is used: "Check generated JS demos".
75
-
76
-
77
+
The "Check generated JS demos" GitHub Action ensures that the React JavaScript and TypeScript sources remain in sync.
0 commit comments