Skip to content

Commit 8bda9a1

Browse files
957932: Updated readme content
1 parent 5521917 commit 8bda9a1

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

README.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,36 @@
11
# Getting Started with React UI Components using Next.js
22

3-
This application demonstrates the usage of the Syncfusion React Diagram component in Next.js.
3+
This application demonstrates the usage of the Syncfusion React Diagram component in Next.js. The Syncfusion React Diagram component is a feature-rich library that enables you to create and manipulate diagrams with ease. It supports various types of diagrams including flowcharts, organizational charts, mind maps, and network diagrams.
4+
5+
## Features
6+
7+
* Interactive diagram creation and editing
8+
* Built-in shape library with 600+ shapes
9+
* Automatic layout algorithms
10+
* Customizable appearance and behavior
11+
* Undo/redo capabilities
12+
* Export to various formats (PNG, JPEG, SVG)
413

514
To know how to configure the Syncfusion React Diagram component in Next.js, refer to the [documentation](https://ej2.syncfusion.com/react/documentation/diagram/nextjs-getting-started).
615

16+
## Prerequisites
17+
18+
* Node.js 14 or later
19+
* npm or yarn package manager
20+
* Basic knowledge of React and Next.js
21+
722
## Clone the repository
823

9-
* To clone the sample repository locally, open the command prompt in the desired location and execute the following command.
24+
To clone the sample repository locally, follow these steps:
1025

11-
```sh
26+
1. Open the command prompt in your desired location
27+
2. Execute the following command:
1228

29+
```sh
1330
git clone https://github.com/SyncfusionExamples/ej2-nextjs-diagram.git
14-
1531
```
1632

17-
* Navigate to the project directory:
33+
Navigate to the project directory:
1834

1935
```sh
2036
cd ej2-nextjs-diagram
@@ -28,10 +44,22 @@ Install the required node modules by running the following command:
2844
npm install
2945
```
3046

47+
This will install all the necessary dependencies including the Syncfusion React Diagram component and its peer dependencies.
48+
3149
## Run the application
3250

33-
To run the application, use the following command:
51+
To run the application in development mode, use the following command:
3452

3553
```bash
3654
npm run dev
55+
```
56+
57+
The application will start on `http://localhost:3000`. Open this URL in your browser to see the diagram component in action.
58+
59+
## Build for Production
60+
61+
To create a production build, run:
62+
63+
```bash
64+
npm run build
3765
```

0 commit comments

Comments
 (0)