Skip to content

Commit ebf8bfe

Browse files
Merge pull request #2 from abinayabalakrishnan-syncfusion/ReadmeUpdate
Documentation update for README
2 parents 8018bc0 + 9ecfb12 commit ebf8bfe

1 file changed

Lines changed: 54 additions & 13 deletions

File tree

README.md

Lines changed: 54 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,68 @@
11
# FileManagerIntegration
22

3-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.7.
3+
**Repository Description**
4+
This repository contains an **Angular application** generated using **Angular CLI** that serves as a starting point for integrating the Syncfusion **Angular File Manager** component.
45

5-
## Development server
6+
The project provides a standard Angular setup that can be extended to include file and folder management capabilities using Syncfusion UI components.
67

7-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
8+
## Project Overview
9+
The purpose of this project is to provide a base Angular application structure that can be used to integrate and configure the Syncfusion Angular File Manager. It helps developers get started with Angular development and extend the application with file management features.
810

9-
## Code scaffolding
11+
## Features
12+
- Angular application generated with **[Angular CLI](https://github.com/angular/angular-cli)**
13+
- Development server support with live reload
14+
- Build and production bundle generation
15+
- Unit testing support using **[Karma](https://karma-runner.github.io)**
16+
- End‑to‑end testing setup capability
17+
- Ready to integrate **Syncfusion Angular File Manager**
1018

11-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
19+
## Prerequisites
20+
Ensure the following requirements are met before running this project:
21+
- Node.js and npm
22+
- Angular CLI version 14.2.7 or later
23+
- A supported modern web browser
1224

13-
## Build
25+
## Installation
1426

15-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
27+
### Clone the Repository
28+
Clone or download this repository to your local machine.
29+
```bash
30+
git https://github.com/SyncfusionExamples/angular-filemanager-pdf-word-excel.git
31+
```
32+
### Install Dependencies
33+
Install the required npm packages:
34+
```bash
35+
npm install
36+
```
37+
### Development Server
38+
Run the development server using:
39+
```bash
40+
ng serve
41+
```
42+
Navigate to `http://localhost:4200/`.
43+
The application automatically reloads when source files are changed.
1644

17-
## Running unit tests
45+
## Configuration
46+
The application is structured using standard Angular modules and components. You can configure additional components, services, or modules to integrate Syncfusion File Manager functionality as required.
1847

19-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
48+
## Documentation
49+
- General Syncfusion documentation:
50+
https://help.syncfusion.com/
51+
- Angular Introduction:
52+
https://ej2.syncfusion.com/angular/documentation/introduction
53+
- Angular File Manager – Getting Started:
54+
https://ej2.syncfusion.com/angular/documentation/file-manager/getting-started
2055

21-
## Running end-to-end tests
56+
## Additional Resources
57+
- Angular CLI overview and command reference:
58+
https://angular.io/cli
2259

23-
Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
24-
25-
## Further help
60+
## Troubleshooting
61+
- Ensure Node.js and npm are installed correctly.
62+
- Verify the Angular CLI version using ng version.
63+
- Re‑run npm install if dependencies fail to install.
64+
- Restart the development server after configuration changes.
2665

66+
## Support
67+
For detailed API references, Angular File Manager integration, and advanced configuration guidance, refer to the Syncfusion Angular documentation links provided above.
2768
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

0 commit comments

Comments
 (0)