Skip to content

Commit 4cc9e95

Browse files
Merge pull request #1 from GokulSaravanan26/patch-1
Documentation (1021684): Improved ReadMe file content.
2 parents 6513ada + a18c5d0 commit 4cc9e95

1 file changed

Lines changed: 33 additions & 10 deletions

File tree

README.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,37 @@
11
# Getting Started with the Angular File Upload Component
2-
A quick-start project that shows how to create and configure the Syncfusion Angular File Upload component. This project contains code to configure a few of the component’s basic features like saving or removing files, auto upload, sequential upload, and preloaded files in the uploader.
3-
4-
Refer to the following documentation to learn about the Angular File Upload component:
5-
https://ej2.syncfusion.com/angular/documentation/uploader/getting-started
62

7-
Check out this online example of the Angular File Upload component:
8-
https://ej2.syncfusion.com/angular/demos/#/fluent2/uploader/default
3+
## Repository Description
4+
A quick-start project demonstrating how to create and configure the Syncfusion Angular File Upload component with practical examples and essential features for file handling in Angular applications.
95

10-
## Project prerequisites
11-
Make sure that you have the compatible versions of [Visual Studio Code](https://code.visualstudio.com/download ) and [NodeJS](https://nodejs.org/en/download) or later version in your machine before starting to work on this project.
6+
## Overview
7+
This project provides a comprehensive guide to implementing the Syncfusion Angular File Upload component. It demonstrates best practices for handling file uploads with features including file saving and removal, automatic upload capabilities, sequential upload processing, and preloaded file management.
128

13-
## How to run this application
14-
To run this application, you need to first clone the `getting-started-with-the-angular-file-upload-component` repository and then open it in Visual Studio Code.Now, simply install all the necessary angular packages into your current project using the `npm install` command and run your project using the `ng serve` command.
9+
## Features
10+
- **File Upload**: Save and manage uploaded files with ease
11+
- **File Removal**: Remove uploaded files from the queue or server
12+
- **Auto Upload**: Automatically upload files without user interaction
13+
- **Sequential Upload**: Upload files one after another in order
14+
- **Preloaded Files**: Display and manage pre-existing files in the uploader
15+
- **Component Configuration**: Easy-to-customize component settings
16+
17+
## Project Prerequisites
18+
Before starting development, ensure you have the following installed:
19+
- [Visual Studio Code](https://code.visualstudio.com/download) - Latest version recommended
20+
- [NodeJS](https://nodejs.org/en/download) - v14.0 or later
21+
22+
## Installation & Setup
23+
1. Clone the repository: `getting-started-with-the-angular-file-upload-component`
24+
2. Open the project in Visual Studio Code
25+
3. Install all necessary Angular packages using: `npm install`
26+
4. Run the project using: `ng serve`
27+
5. Access the application in your browser at the provided local URL
28+
29+
## Usage
30+
Configure the Angular File Upload component according to your application requirements. Customize upload settings, file validation rules, and upload handlers to match your specific use case.
31+
32+
## Documentation & Resources
33+
- [Angular File Upload Documentation](https://ej2.syncfusion.com/angular/documentation/uploader/getting-started)
34+
- [Angular File Upload Demo](https://ej2.syncfusion.com/angular/demos/#/fluent2/uploader/default)
35+
36+
## Getting Started
37+
Simply clone the repository, install dependencies with npm, and run the development server to see the Angular File Upload component in action with all configured features ready to use.

0 commit comments

Comments
 (0)