Skip to content

Commit 8aa72ca

Browse files
Merge pull request #5 from abinayabalakrishnan-syncfusion/ReadmeUpdate
Documentation update for README
2 parents 57e09e1 + 761256d commit 8aa72ca

1 file changed

Lines changed: 56 additions & 22 deletions

File tree

README.md

Lines changed: 56 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,71 @@
11
# Getting Started with React UI Components using Next.js
2+
3+
**Repository Description**
4+
This repository contains a sample **Next.js application** that demonstrates how to integrate and use the Syncfusion **React File Manager** component within a React environment powered by Next.js.
5+
6+
The sample focuses on configuring the File Manager component in a Next.js setup, allowing developers to manage and browse files through a web‑based UI built with React and Syncfusion components.
7+
8+
## Project Overview
9+
The purpose of this project is to help developers understand how to configure and use the Syncfusion React File Manager component in a Next.js application. It serves as a reference implementation for integrating file management functionality into server‑rendered or hybrid React applications.
10+
11+
## Features
12+
- Integration of Syncfusion **React File Manager** with **Next.js**
13+
- File and folder browsing through a web UI
14+
- React‑based File Manager component configuration
15+
- Development‑ready project structure for Next.js applications
16+
17+
## Prerequisites
18+
Ensure the following requirements are met before running this project:
19+
- Node.js (LTS version recommended)
20+
- npm package manager
21+
- Basic understanding of React and Next.js
22+
23+
## How to run the sample
224

3-
This application demonstrates the usage of the Syncfusion React file-manager component in Next.js.
4-
5-
To know how to configure the Syncfusion React file-manager component in Next.js, refer to the [documentation](https://ej2.syncfusion.com/react/documentation/file-manager/nextjs-getting-started).
6-
7-
## Clone the repository
8-
9-
* To clone the sample repository locally, open the command prompt in the desired location and execute the following command.
10-
11-
```sh
12-
25+
### Clone the repository
26+
* To clone the sample repository locally, open the command prompt in the desired location and execute the following command.
27+
```sh
1328
git clone https://github.com/SyncfusionExamples/syncfusion-react-filemanager-component-in-nextjs
14-
1529
```
16-
1730
* Navigate to the project directory:
18-
1931
```sh
2032
cd syncfusion-react-filemanager-component-in-nextjs
2133
```
22-
23-
## Installing Packages
24-
34+
### Installing Packages
2535
Install the required node modules by running the following command:
26-
2736
```sh
2837
npm install
2938
```
30-
31-
## Run the application
32-
39+
### Run the application
3340
To run the application, use the following command:
34-
3541
```bash
3642
npm run dev
37-
```
43+
```
44+
After the server starts successfully, open your browser and navigate to the URL shown in the terminal (typically `http://localhost:3000`) to view the React File Manager running in a Next.js application.
45+
46+
## Configuration
47+
The File Manager component is configured within the Next.js project using standard React patterns. You can extend this configuration to:
48+
- Change file sources
49+
- Customize File Manager behavior
50+
- Integrate authentication or service‑based file providers
51+
52+
## Documentation
53+
- General Syncfusion documentation:
54+
https://help.syncfusion.com/
55+
- React Introduction:
56+
https://ej2.syncfusion.com/react/documentation/introduction
57+
- React File Manager – Next.js Getting Started:
58+
https://ej2.syncfusion.com/react/documentation/file-manager/nextjs-getting-started
59+
60+
## Additional Resources
61+
- Syncfusion React File Manager product overview:
62+
https://www.syncfusion.com/react-ui-components/react-file-manager
63+
64+
## Troubleshooting
65+
- Ensure Node.js and npm are installed correctly.
66+
- Re‑run npm install if dependencies fail to install.
67+
- Restart the development server if changes are not reflected.
68+
- Check terminal and browser console logs for errors.
69+
70+
## Support
71+
For detailed API references, Next.js integration guidance, and advanced File Manager usage scenarios, refer to the Syncfusion React documentation links provided above.

0 commit comments

Comments
 (0)