Skip to content

Commit 403f17c

Browse files
authored
Merge pull request #5 from Vaseegaran-SF4468/EJ2-957932-Readme
957932: Updated readme content
2 parents 5521917 + b995e1e commit 403f17c

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
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.
44

55
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).
66

7+
## Prerequisites
8+
9+
* Node.js 14 or later
10+
* npm or yarn package manager
11+
* Basic knowledge of React and Next.js
12+
713
## Clone the repository
814

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

11-
```sh
17+
1. Open the command prompt in your desired location
18+
2. Execute the following command:
1219

20+
```sh
1321
git clone https://github.com/SyncfusionExamples/ej2-nextjs-diagram.git
14-
1522
```
1623

17-
* Navigate to the project directory:
24+
Navigate to the project directory:
1825

1926
```sh
2027
cd ej2-nextjs-diagram
@@ -28,10 +35,22 @@ Install the required node modules by running the following command:
2835
npm install
2936
```
3037

38+
This will install all the necessary dependencies including the Syncfusion React Diagram component and its peer dependencies.
39+
3140
## Run the application
3241

33-
To run the application, use the following command:
42+
To run the application in development mode, use the following command:
3443

3544
```bash
3645
npm run dev
46+
```
47+
48+
The application will start on `http://localhost:3000`. Open this URL in your browser to see the diagram component in action.
49+
50+
## Build for Production
51+
52+
To create a production build, run:
53+
54+
```bash
55+
npm run build
3756
```

0 commit comments

Comments
 (0)