@progress/kendo-cli 1.0.0
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/LICENSE.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
This project has been released under the [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html), the text of which is included below. This license applies ONLY to the source of this repository and does not extend to any other Kendo UI distribution or variant, or any other 3rd party libraries used in a repository. For licensing information about KendoReact, see the [License Agreements page](https://www.telerik.com/purchase/license-agreement/progress-kendoreact) at [KendoReact.com](http://www.kendoreact.com).
|
|
2
|
+
|
|
3
|
+
> Copyright © 2023 Progress Software Corporation and/or its subsidiaries or affiliates.
|
|
4
|
+
|
|
5
|
+
> Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
|
+
> you may not use this file except in compliance with the License.
|
|
7
|
+
> You may obtain a copy of the License at
|
|
8
|
+
|
|
9
|
+
> [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
|
|
10
|
+
|
|
11
|
+
> Unless required by applicable law or agreed to in writing, software
|
|
12
|
+
> distributed under the License is distributed on an "AS IS" BASIS,
|
|
13
|
+
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
14
|
+
> See the License for the specific language governing permissions and
|
|
15
|
+
> limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Kendo CLI
|
|
2
|
+
|
|
3
|
+
To install:
|
|
4
|
+
|
|
5
|
+
``` bash
|
|
6
|
+
npm install --global @progress/kendo-cli
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## KendoReact Project Generator
|
|
10
|
+
|
|
11
|
+
> Kendo ♥ Next.js
|
|
12
|
+
|
|
13
|
+
To use ***KendoReact*** and create a new ***React*** project using ***Next.js***:
|
|
14
|
+
|
|
15
|
+
``` bash
|
|
16
|
+
# JavaScript with routing
|
|
17
|
+
npx kendo react create nextjs MyKendoApp --theme
|
|
18
|
+
# JavaScript without routing
|
|
19
|
+
npx kendo react create nextjs MyKendoApp --no-app
|
|
20
|
+
# TypeScript with routing
|
|
21
|
+
npx kendo react create nextjs MyKendoApp --ts
|
|
22
|
+
# TypeScript without routing
|
|
23
|
+
npx kendo react create nextjs MyKendoApp --ts --no-app
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### Options
|
|
27
|
+
|
|
28
|
+
Language options:
|
|
29
|
+
- `--js` - Use JavaScript (default)
|
|
30
|
+
- `--ts` - Use TypeScript
|
|
31
|
+
|
|
32
|
+
Theme options:
|
|
33
|
+
|
|
34
|
+
- `--theme=default`
|
|
35
|
+
- `--theme=bootstrap`
|
|
36
|
+
- `--theme=material`
|
|
37
|
+
|
|
38
|
+
Other:
|
|
39
|
+
|
|
40
|
+
- `--eslint` - Initialize with eslint config.
|
|
41
|
+
- `--no-app` - Initialize as **no** App Router project.
|
|
42
|
+
- `--no-src-dir` - Initialize without a `src/` directory.
|
|
43
|
+
- `--import-alias="@/*"` - Specify import alias to use.
|
|
44
|
+
|
|
45
|
+
### Build and Run
|
|
46
|
+
|
|
47
|
+
After the project is generated, navigate into the new directory, install packages, build and run:
|
|
48
|
+
|
|
49
|
+
``` bash
|
|
50
|
+
cd MyKendoApp
|
|
51
|
+
npm install
|
|
52
|
+
npm run dev
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### KendoReact Project Generator Synopsis
|
|
56
|
+
|
|
57
|
+
```
|
|
58
|
+
kendo react create nextjs [name]
|
|
59
|
+
|
|
60
|
+
Create KendoReact app based on NextJS
|
|
61
|
+
|
|
62
|
+
Positionals:
|
|
63
|
+
name Name of the generated application. [string] [default: "KendoReactApp"]
|
|
64
|
+
|
|
65
|
+
Options:
|
|
66
|
+
--help Show help [boolean]
|
|
67
|
+
--version Show version number [boolean]
|
|
68
|
+
-v, --verbose Set verbosity level, e.g. -vvv sets verbosity to level
|
|
69
|
+
3. max 5. [count] [default: 1]
|
|
70
|
+
-q, --quiet Silence output as much as possible. Sets verbosity to
|
|
71
|
+
level 0. [boolean] [default: false]
|
|
72
|
+
--javascript, --js Initialize as a JavaScript project.
|
|
73
|
+
[boolean] [default: false]
|
|
74
|
+
--typescript, --ts Initialize as a TypeScript project.
|
|
75
|
+
[boolean] [default: false]
|
|
76
|
+
--eslint Initialize with eslint config.
|
|
77
|
+
[boolean] [default: false]
|
|
78
|
+
--app Initialize as an App Router project.
|
|
79
|
+
[boolean] [default: true]
|
|
80
|
+
--src-dir Initialize inside a `src/` directory.
|
|
81
|
+
[boolean] [default: true]
|
|
82
|
+
--import-alias Specify import alias to use (default "@/*").
|
|
83
|
+
[string] [default: "@/*"]
|
|
84
|
+
--theme Kendo theme to apply.
|
|
85
|
+
[string] [choices: "default", "bootstrap", "material"] [default: "default"]
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
_Copyright © 2023 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved._
|
|
91
|
+
|
|
92
|
+
_Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software_ _Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries._
|