Skip to content

Commit 88abb97

Browse files
committed
Documentation(1023120); Update sample and ReadME
1 parent de7c030 commit 88abb97

2 files changed

Lines changed: 58 additions & 1 deletion

File tree

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Angular Syncfusion Grid Client with Web API Adaptor
2+
3+
An Angular client application built to interact with backend Web APIs.
4+
5+
## Repository Description
6+
7+
An Angular-based frontend application that acts as a client-side adaptor for consuming, managing, and visualizing data from RESTful Web APIs. The project is structured to demonstrate clean API integration patterns, modular Angular architecture, and scalable frontend development practices.
8+
9+
## Overview
10+
11+
**WebapiadaptorClient** is a frontend Angular application designed to consume and display data from RESTful Web APIs. The application is structured for scalability, maintainability, and ease of development, making it suitable for enterprise and integration-focused use cases.
12+
13+
## Prerequisites
14+
15+
- **Angular** 17.2.3
16+
- **TypeScript**
17+
- **HTML / SCSS**
18+
- **Node.js**
19+
- **Angular CLI**
20+
21+
## Key Features
22+
23+
- Data binding using Syncfusion EJ2 Angular Grid
24+
- Server-driven data consumption via RESTful Web APIs
25+
- Paging, sorting, and filtering capabilities
26+
- Inline editing with primary key support
27+
- Toolbar actions for common grid operations
28+
- Configurable and extensible column defi
29+
30+
31+
## Running the Application
32+
33+
1. Clone the project repository
34+
```
35+
git clone <repo_link>
36+
```
37+
2. Navigate to the client application and install dependencies
38+
```
39+
cd WebApiAdaptor.Client
40+
npm i
41+
```
42+
3. Navigate to the server project and build the application
43+
```
44+
cd ../WebApiAdaptor.Server
45+
dotnet build
46+
```
47+
4. Run the server
48+
```
49+
dotnet run
50+
```
51+
52+
## Reference Documentation
53+
54+
- [Getting started with EJ2 Angular](https://ej2.syncfusion.com/angular/documentation/grid/getting-started)
55+
- [Editing](https://ej2.syncfusion.com/angular/documentation/grid/editing/edit)
56+
- [Angular Grid API](https://ej2.syncfusion.com/angular/documentation/api/grid/index-default)

WebApiAdaptor.Client/src/app/app.component.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ export class AppComponent {
1616
ngOnInit(): void {
1717
this.data = new DataManager({
1818
url: 'https://localhost:7041/api/Orders',
19-
adaptor: new WebApiAdaptor()
19+
adaptor: new WebApiAdaptor(),
20+
crossDomain:true
2021
});
2122

2223
this.editSettings = { allowEditing: true, allowAdding: true, allowDeleting: true, mode: 'Normal' };

0 commit comments

Comments
 (0)