Skip to content

Commit 498cc97

Browse files
Update README.md
update README with available commands
1 parent 7954384 commit 498cc97

File tree

1 file changed

+40
-50
lines changed

1 file changed

+40
-50
lines changed
Lines changed: 40 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,40 @@
1-
# React + TypeScript + Vite
2-
3-
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
4-
5-
Currently, two official plugins are available:
6-
7-
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
8-
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
9-
10-
## Expanding the ESLint configuration
11-
12-
If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
13-
14-
- Configure the top-level `parserOptions` property like this:
15-
16-
```js
17-
export default tseslint.config({
18-
languageOptions: {
19-
// other options...
20-
parserOptions: {
21-
project: ['./tsconfig.node.json', './tsconfig.app.json'],
22-
tsconfigRootDir: import.meta.dirname,
23-
},
24-
},
25-
})
26-
```
27-
28-
- Replace `tseslint.configs.recommended` to `tseslint.configs.recommendedTypeChecked` or `tseslint.configs.strictTypeChecked`
29-
- Optionally add `...tseslint.configs.stylisticTypeChecked`
30-
- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and update the config:
31-
32-
```js
33-
// eslint.config.js
34-
import react from 'eslint-plugin-react'
35-
36-
export default tseslint.config({
37-
// Set the react version
38-
settings: { react: { version: '18.3' } },
39-
plugins: {
40-
// Add the react plugin
41-
react,
42-
},
43-
rules: {
44-
// other rules...
45-
// Enable its recommended rules
46-
...react.configs.recommended.rules,
47-
...react.configs['jsx-runtime'].rules,
48-
},
49-
})
50-
```
1+
## The following KendoReact components are used in the sample application:
2+
3+
- [Data Grid](https://www.telerik.com/kendo-react-ui/components/grid/)
4+
5+
- [Chart](https://www.telerik.com/kendo-react-ui/components/chart/)
6+
7+
- [ChartWizard](https://www.telerik.com/kendo-react-ui/components/chart-wizard)
8+
9+
- [DropdownList](https://www.telerik.com/kendo-react-ui/components/dropdowns/dropdownlist)
10+
11+
- [Input](https://www.telerik.com/kendo-react-ui/components/inputs/input)
12+
13+
- [MaskedTextBox](https://www.telerik.com/kendo-react-ui/components/inputs/maskedtextbox)
14+
15+
- [Appbar](https://www.telerik.com/kendo-react-ui/components/layout/appbar)
16+
17+
- [Button](https://www.telerik.com/kendo-react-ui/components/buttons/button)
18+
19+
- [Form](https://www.telerik.com/kendo-react-ui/components/form)
20+
21+
## Prerequisites
22+
23+
- Node.js [18.17](https://nodejs.org/en) or later.
24+
- macOS, Windows (including WSL), and Linux are supported.
25+
26+
## Installation
27+
28+
Run `npm install`
29+
30+
## Available Scripts
31+
In the project directory, you can run:
32+
33+
### `npm run build`
34+
Build the application for production usage.
35+
36+
### `npm run dev`
37+
Start a Vite production server.
38+
39+
### `npm run lint`
40+
Check for linting errors.

0 commit comments

Comments
 (0)