Skip to content

Commit 9f160a4

Browse files
Update README.md
1 parent 9a7b9bb commit 9f160a4

File tree

1 file changed

+41
-10
lines changed

1 file changed

+41
-10
lines changed

Vue/README.md

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
1-
# vue-project
1+
# Vue 3 + TypeScript + Vite + DevExtreme
22

3-
This template should help get you started developing with Vue 3 in Vite.
3+
This template should help get you started developing with Vue 3 in Vite and DevExtreme components.
4+
5+
This project includes:
6+
- Vue 3.2.45
7+
- TypeScript 4.7.4
8+
- Vite for fast development and building
9+
- DevExtreme Vue 25.1.3
10+
- Vue Router 4.1.6
11+
- Vitest for testing
12+
- ESLint and Prettier for code quality
413

514
## Recommended IDE Setup
615

7-
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
16+
For best TypeScript support in VS Code, see the official Vue guide: [Using Vue with TypeScript in VS Code](https://vuejs.org/guide/typescript/overview#using-vue-with-typescript).
817

918
## Type Support for `.vue` Imports in TS
1019

11-
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
20+
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. For editor integration, see the official Vue guide: [Using Vue with TypeScript in VS Code](https://vuejs.org/guide/typescript/overview#using-vue-with-typescript).
1221

13-
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/vuejs/language-tools/discussions/471) that is more performant. You can enable it by the following steps:
1422

15-
1. Disable the built-in TypeScript Extension
16-
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
17-
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
18-
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
23+
> **Note:**
24+
> To type-check your project, use:
25+
> ```sh
26+
> npm run type-check
27+
> ```
28+
> This uses `vue-tsc` to provide type checking for `.vue` files, as recommended in the [official Vue TypeScript guide](https://vuejs.org/guide/typescript/overview.html).
1929
2030
## Customize configuration
2131
@@ -27,12 +37,31 @@ See [Vite Configuration Reference](https://vite.dev/config/).
2737
npm install
2838
```
2939
40+
## Code Structure
41+
42+
**Source Files:**
43+
- `src/App.vue` - Main Vue application component with router
44+
- `src/main.ts` - Application entry point
45+
- `src/components/HomeContent.vue` - Example component with DevExtreme Button
46+
- `src/components/__tests__/` - Component tests
47+
- `src/views/HomeView.vue` - Home page view
48+
- `src/router/index.ts` - Vue Router configuration
49+
- `src/assets/` - Static assets
50+
51+
**Configuration Files:**
52+
- `vite.config.ts` - Vite configuration with Vue and DevExtreme optimizations
53+
- `package.json` - Dependencies and scripts
54+
- `tsconfig.json` - TypeScript configuration
55+
- `tsconfig.vitest.json` - Vitest-specific TypeScript configuration
56+
3057
### Compile and Hot-Reload for Development
3158
3259
```sh
3360
npm run dev
3461
```
3562
63+
The application will be available at `http://localhost:5173/`
64+
3665
### Type-Check, Compile and Minify for Production
3766
3867
```sh
@@ -53,5 +82,7 @@ npm run lint
5382
### Further help
5483
5584
You can learn more about Vue in the [Vue documentation](https://vuejs.org/guide/introduction.html).
85+
You can learn more about Vite in the [Vite documentation](https://vite.dev/).
86+
You can learn more about DevExtreme Vue components in the [DevExtreme Vue documentation](https://js.devexpress.com/Vue/).
5687
57-
To get more help on DevExtreme submit an issue on [GitHub](https://github.com/DevExpress/devextreme/issues) or [Support Center](https://www.devexpress.com/Support/Center/Question/Create)
88+
To get more help on DevExtreme submit an issue on [GitHub](https://github.com/DevExpress/devextreme/issues) or [Support Center](https://supportcenter.devexpress.com/ticket/create)

0 commit comments

Comments
 (0)