Skip to content

Commit bb45d36

Browse files
DinakarSF4212DinakarSF4212
committed
1023830: Added README content and sample getting started project.
1 parent a0751c8 commit bb45d36

15 files changed

Lines changed: 127 additions & 161 deletions

File tree

‎.gitignore‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

‎README.md‎

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,41 @@
11
# Getting Started with the Vue Spreadsheet Component
22

3-
A quick-start project that helps you create and configure the Syncfusion Vue Spreadsheet component. This project contains code snippets for data binding, as well as importing and exporting Excel files from the Spreadsheet.
3+
A quick-start project that helps you create and configure the **Syncfusion Vue Spreadsheet component**. This project allows you to clone the repository and run the application to get started quickly.
44

5-
The getting started documentation for the Syncfusion Vue Spreadsheet component:
6-
https://ej2.syncfusion.com/vue/documentation/spreadsheet/vue-3-getting-started
5+
## Project Prerequisites
76

8-
Check out this online example of the quick info template in the Syncfusion Vue Spreadsheet component:
9-
https://ej2.syncfusion.com/vue/demos/#/material3/spreadsheet/default.html
7+
- Node.js (v14.15.0 or higher recommended)
8+
- Vue 3
9+
- Vite
10+
- npm
1011

11-
Tutorial video: https://www.syncfusion.com/tutorial-videos
12+
## Recommended IDE Setup
1213

13-
## Project prerequisites
14+
- Visual Studio Code
15+
- Volar (disable Vetur)
16+
- TypeScript Vue Plugin (Volar)
1417

15-
### Vue 3 + Vite
16-
17-
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
18-
19-
### Recommended IDE Setup
18+
## How to run this application?
2019

21-
- [VS Code](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).
20+
1. Clone the `getting-started-with-the-vue-spreadsheet-component` repository.
21+
2. Open the project in Visual Studio Code.
22+
3. Install the required packages using:
23+
```
24+
npm install
25+
```
26+
4. Run the project using:
27+
```
28+
npm run dev
29+
```
30+
5. Open the application URL shown in the terminal (typically http://localhost:5173).
2231

32+
## Documentation
2333

24-
## How to run this application?
34+
- Getting Started Guide:
35+
https://ej2.syncfusion.com/vue/documentation/spreadsheet/vue-3-getting-started
2536

26-
To run this application, you need to clone the `getting-started-with-the-vue-spreadsheet-component` repository and then open it in Visual Studio Code. Now, simply install all the necessary packages into your current project using the `npm install` command and run your project using the `npm run dev` command.
37+
- Online Demo:
38+
https://ej2.syncfusion.com/vue/demos/#/material3/spreadsheet/default.html
2739

40+
- Tutorial Videos:
41+
https://www.syncfusion.com/tutorial-videos

‎index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<html lang="en">
33
<head>
44
<meta charset="UTF-8" />
5-
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
5+
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Vite + Vue</title>
7+
<title>spreadsheet-app</title>
88
</head>
99
<body>
1010
<div id="app"></div>

‎package.json‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "myvueapp",
2+
"name": "spreadsheet-app",
33
"private": true,
44
"version": "0.0.0",
55
"type": "module",
@@ -9,11 +9,11 @@
99
"preview": "vite preview"
1010
},
1111
"dependencies": {
12-
"@syncfusion/ej2-vue-spreadsheet": "^24.1.45",
13-
"vue": "^3.3.11"
12+
"@syncfusion/ej2-vue-spreadsheet": "*",
13+
"vue": "^3.5.32"
1414
},
1515
"devDependencies": {
16-
"@vitejs/plugin-vue": "^4.5.2",
17-
"vite": "^5.0.8"
16+
"@vitejs/plugin-vue": "^6.0.6",
17+
"vite": "^8.0.10"
1818
}
1919
}

‎public/favicon.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎public/icons.svg‎

Lines changed: 24 additions & 0 deletions
Loading

‎public/vite.svg‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)