Skip to content

Commit 01fffaa

Browse files
committed
1023830: Added README content and sample getting started project.
1 parent 8146090 commit 01fffaa

31 files changed

Lines changed: 2870 additions & 467 deletions

.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: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,29 @@
11
# Getting Started with the React Spreadsheet Component
22

3-
A quick-start project that shows how to create and configure the Syncfusion React Spreadsheet component. This project also contains code example to configure a few of the control’s basic features like data-binding, importing, and exporting Excel documents.
3+
A quick-start project that helps you create and configure the Syncfusion React Spreadsheet component. This project enables users to clone and run the app easily to explore Spreadsheet features.
44

5-
Documentation: https://ej2.syncfusion.com/react/documentation/spreadsheet/getting-started/
5+
## Documentation
66

7-
Online examples: https://ej2.syncfusion.com/react/demos/#/bootstrap5/spreadsheet/default
7+
- Getting Started Guide: https://help.syncfusion.com/document-processing/excel/spreadsheet/react/getting-started
8+
- Online Demo: https://document.syncfusion.com/demos/spreadsheet-editor/react/#/tailwind3/spreadsheet/default
9+
- Tutorial Videos: https://www.syncfusion.com/tutorial-videos/react/spreadsheet
810

9-
## Project prerequisites
11+
## Project Prerequisites
1012

11-
Make sure that you have the latest versions of NodeJS and Visual Studio Code in your machine before starting to work on this project.
13+
- Node.js(v14.15.0 or higher)
14+
- npm or yarn
15+
- React (latest stable)
1216

13-
### How to run this application?
17+
## How to run this application?
1418

15-
To run this application, you need to clone the `getting-started-with-the-react-spreadsheet-component` repository and then open it in Visual Studio Code. Now, simply install all the necessary react packages into your current project using the `npm install` command and run your project using the `npm start` command.
19+
1. Clone the repository.
20+
2. Open the project in Visual Studio Code.
21+
3. Install the required dependencies using:
22+
```
23+
npm install
24+
```
25+
4. Run the application using:
26+
```
27+
npm start
28+
```
29+
5. Open http://localhost:3000 in your browser.

eslint.config.js

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import js from '@eslint/js'
2+
import globals from 'globals'
3+
import reactHooks from 'eslint-plugin-react-hooks'
4+
import reactRefresh from 'eslint-plugin-react-refresh'
5+
import { defineConfig, globalIgnores } from 'eslint/config'
6+
7+
export default defineConfig([
8+
globalIgnores(['dist']),
9+
{
10+
files: ['**/*.{js,jsx}'],
11+
extends: [
12+
js.configs.recommended,
13+
reactHooks.configs.flat.recommended,
14+
reactRefresh.configs.vite,
15+
],
16+
languageOptions: {
17+
globals: globals.browser,
18+
parserOptions: { ecmaFeatures: { jsx: true } },
19+
},
20+
},
21+
])

index.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>spreadsheet-app</title>
8+
</head>
9+
<body>
10+
<div id="root"></div>
11+
<script type="module" src="/src/main.jsx"></script>
12+
</body>
13+
</html>

0 commit comments

Comments
 (0)