Skip to content

Commit

Permalink
Added readme files for all samples
Browse files Browse the repository at this point in the history
  • Loading branch information
NithyaSivaprakasam committed Jun 27, 2024
1 parent d505bf6 commit bed351b
Show file tree
Hide file tree
Showing 9 changed files with 271 additions and 2 deletions.
39 changes: 39 additions & 0 deletions GraphQLAdaptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Connecting GraphQL Service with Javascript Grid Control

GraphQL is a powerful query language for APIs, designed to provide a more efficient alternative to traditional REST APIs. It allows you to precisely fetch the data you need, reducing over-fetching and under-fetching of data. GraphQL provides a flexible and expressive syntax for querying, enabling clients to request only the specific data they require.

Syncfusion’s Grid component seamlessly integrates with GraphQL servers using the GraphQLAdaptor in the DataManager. This specialized adaptor simplifies the interaction between the Syncfusion Grid and GraphQL servers, allowing efficient data retrieval with support for various operations like CRUD (Create, Read, Update, Delete), paging, sorting, and filtering.

## Add Syncfusion Grid component in your application

Refer the following UG documenation for adding Syncfusion Grid component in your application
* [Getting Started of Syncfusion Javascript Grid component](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)

## GraphQL Server setup

You can setup GraphQL server by using `graphpack` npm package. Find the following link for getting more details for your reference.

* [graphpack npm package](https://www.npmjs.com/package/graphpack)

## Run the GraphQL Server

To run the server, install the required packages using the following command:

```bash
npm install
```
Then, start the server with:
```bash
npm run dev
```
## Run the client Grid application

Open `index.html` in a web browser to run the client-side Syncfusion Grid application.

## Resources

You can also refer the below resources to know more details about Syncfusion Javascript Grid components.

* [Demo](https://ej2.syncfusion.com/javascript/demos/#/bootstrap/grid/over-view)
* [Documentation](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)
* [GraphQL with Syncfusion DataManager](https://ej2.syncfusion.com/javascript/documentation/grid/connecting-to-adaptors/graphql-adaptor)
34 changes: 34 additions & 0 deletions ODataV4Adaptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# ODataV4Adaptor in Syncfusion Grid Component

The ODataV4Adaptor in the Syncfusion Grid Component allows seamless integration of the Grid with OData v4 services, enabling efficient data fetching and manipulation. This guide provides detailed instructions on binding data and performing CRUD (Create, Read, Update, Delete) actions using the ODataV4Adaptor in your Syncfusion Grid Component.

## Getting Started

**1. Clone the Repository:**

Use `git clone` to fetch the repository from GitHub.

```bash
https://github.com/SyncfusionExamples/Binding-data-from-remote-service-to-javascript-data-grid.git
```

**2. Open and Build the Project:**

* Open the project in Visual Studio.
* Build the project to restore dependencies and compile it.
* Run the project

**3. Explore the Code:**

* Navigate to JavaScript files (typically in wwwroot).
* Debug and interact with the code as needed.

![Adaptors](../assets/images/adaptor-crud-operation.gif)

## Resources

You can also refer the below resources to know more details about Syncfusion Javascript Grid components.

* [Demo](https://ej2.syncfusion.com/javascript/demos/#/bootstrap/grid/over-view)
* [Documentation](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)
* [GraphQL with Syncfusion DataManager](https://ej2.syncfusion.com/javascript/documentation/grid/connecting-to-adaptors/odatav4-adaptor)
62 changes: 60 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,60 @@
# Binding-data-from-remote-service-to-javascript-data-grid
Discover seamless remote data integration with Syncfusion EJ2 Javascript Grid in this sample repository. Explore efficient techniques for handling filtering, sorting, paging operations, and CRUD operations within your Javascript applications, empowering you to manage and display data effectively.
# Binding data from remote service to javascript data grid

## Overview

This repository demonstrates how to bind data from various remote services to a Syncfusion Essential JS 2 (EJ2) JavaScript Data Grid. It provides examples for integrating data using different adaptors and showcases techniques for handling filtering, sorting, paging, and CRUD operations within JavaScript applications. By exploring this repository, you will learn how to efficiently manage and display data in your applications.

## Features

**Remote Data Integration:** Seamlessly bind data from various remote services to the Syncfusion EJ2 JavaScript Grid.

**Data Operations:** Handle filtering, sorting, and paging operations with ease.

**CRUD Operations:** Implement Create, Read, Update, and Delete operations.

**Adaptors:** Examples of different adaptors to integrate remote data:
* UrlAdaptor
* WebApiAdaptor
* WebMethodAdaptor
* ODataV4Adaptor
* GraphQLAdaptor
* RemoteSaveAdaptor

## Prerequisites

Before you begin, ensure you have met the following requirements:

* Node.js and npm installed

* Basic knowledge of JavaScript and web development

## Getting Started

**1. Clone the Repository:**

Use `git clone` to fetch the repository from GitHub.

```bash
https://github.com/SyncfusionExamples/Binding-data-from-remote-service-to-javascript-data-grid.git
```

**2. Open and Build the Project:**

* Open the project in Visual Studio.
* Build the project to restore dependencies and compile it.
* Run the project

**3. Explore the Code:**

* Navigate to JavaScript files (typically in wwwroot).
* Debug and interact with the code as needed.

![Adaptors](./assets/images/adaptor-crud-operation.gif)

## Resources

You can also refer the below resources to know more details about Syncfusion Javascript Grid components.

* [Demo](https://ej2.syncfusion.com/javascript/demos/#/bootstrap/grid/over-view)
* [Documentation](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)
* [GraphQL with Syncfusion DataManager](https://ej2.syncfusion.com/javascript/documentation/grid/connecting-to-adaptors)
34 changes: 34 additions & 0 deletions RemoteSaveAdaptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Binding and perform CRUD operation using RemoteSaveAdaptor

The RemoteSaveAdaptor in Syncfusion Grid Component allows you to perform grid actions such as sorting, filtering, searching and paging primarily on the client-side while handling CRUD operations, such as updating, inserting, and removing data, on the server-side for data persistence. This approach optimizes your experience by minimizing unnecessary server interactions.

## Getting Started

**1. Clone the Repository:**

Use `git clone` to fetch the repository from GitHub.

```bash
https://github.com/SyncfusionExamples/Binding-data-from-remote-service-to-javascript-data-grid.git
```

**2. Open and Build the Project:**

* Open the project in Visual Studio.
* Build the project to restore dependencies and compile it.
* Run the project

**3. Explore the Code:**

* Navigate to JavaScript files (typically in wwwroot).
* Debug and interact with the code as needed.

![Adaptors](../assets/images/adaptor-crud-operation.gif)

## Resources

You can also refer the below resources to know more details about Syncfusion Javascript Grid components.

* [Demo](https://ej2.syncfusion.com/javascript/demos/#/bootstrap/grid/over-view)
* [Documentation](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)
* [GraphQL with Syncfusion DataManager](https://ej2.syncfusion.com/javascript/documentation/grid/connecting-to-adaptors/remote-save-adaptor)
34 changes: 34 additions & 0 deletions UrlAdaptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# UrlAdaptor in Syncfusion Grid Component

The UrlAdaptor serves as the base adaptor for facilitating communication between remote data services and an UI component. It enables seamless data binding and interaction with custom API services or any remote service through URLs. The UrlAdaptor is particularly useful for the scenarios where a custom API service with unique logic for handling data and CRUD operations is in place. This approach allows for custom handling of data and CRUD operations, and the resultant data returned in the result and count format for display in the Syncfusion Grid component.

## Getting Started

**1. Clone the Repository:**

Use `git clone` to fetch the repository from GitHub.

```bash
https://github.com/SyncfusionExamples/Binding-data-from-remote-service-to-javascript-data-grid.git
```

**2. Open and Build the Project:**

* Open the project in Visual Studio.
* Build the project to restore dependencies and compile it.
* Run the project

**3. Explore the Code:**

* Navigate to JavaScript files (typically in wwwroot).
* Debug and interact with the code as needed.

![Adaptors](../assets/images/adaptor-crud-operation.gif)

## Resources

You can also refer the below resources to know more details about Syncfusion Javascript Grid components.

* [Demo](https://ej2.syncfusion.com/javascript/demos/#/bootstrap/grid/over-view)
* [Documentation](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)
* [GraphQL with Syncfusion DataManager](https://ej2.syncfusion.com/javascript/documentation/grid/connecting-to-adaptors/url-adaptor)
34 changes: 34 additions & 0 deletions WebApiAdaptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# WebApiAdaptor in Syncfusion Grid Component

The WebApiAdaptor is an extension of the ODataAdaptor, designed to interact with Web APIs created with OData endpoints. This adaptor ensures seamless communication between Syncfusion Grid and OData-endpoint based Web APIs, enabling efficient data retrieval and manipulation. For successful integration, the endpoint must be capable of understanding OData-formatted queries sent along with the request.

## Getting Started

**1. Clone the Repository:**

Use `git clone` to fetch the repository from GitHub.

```bash
https://github.com/SyncfusionExamples/Binding-data-from-remote-service-to-javascript-data-grid.git
```

**2. Open and Build the Project:**

* Open the project in Visual Studio.
* Build the project to restore dependencies and compile it.
* Run the project

**3. Explore the Code:**

* Navigate to JavaScript files (typically in wwwroot).
* Debug and interact with the code as needed.

![Adaptors](../assets/images/adaptor-crud-operation.gif)

## Resources

You can also refer the below resources to know more details about Syncfusion Javascript Grid components.

* [Demo](https://ej2.syncfusion.com/javascript/demos/#/bootstrap/grid/over-view)
* [Documentation](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)
* [GraphQL with Syncfusion DataManager](https://ej2.syncfusion.com/javascript/documentation/grid/connecting-to-adaptors/web-api-adaptor)
36 changes: 36 additions & 0 deletions WebMethodAdaptor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# WebMethodAdaptor in Syncfusion Grid Component

The WebMethodAdaptor in Syncfusion Grid facilitates data binding from remote services using web methods. This powerful feature enables efficient communication between the client-side application and the server. The WebMethodAdaptor, like the URL adaptor, sends query parameters encapsulated within an object named value. Within this value object, various datamanager properties such as requiresCounts, skip, take, sorted, and where queries are included.

[WebMethodAdaptor](../assets/images/web-method-adaptor-value.png)

## Getting Started

**1. Clone the Repository:**

Use `git clone` to fetch the repository from GitHub.

```bash
https://github.com/SyncfusionExamples/Binding-data-from-remote-service-to-javascript-data-grid.git
```

**2. Open and Build the Project:**

* Open the project in Visual Studio.
* Build the project to restore dependencies and compile it.
* Run the project

**3. Explore the Code:**

* Navigate to JavaScript files (typically in wwwroot).
* Debug and interact with the code as needed.

![Adaptors](../assets/images/adaptor-crud-operation.gif)

## Resources

You can also refer the below resources to know more details about Syncfusion Javascript Grid components.

* [Demo](https://ej2.syncfusion.com/javascript/demos/#/bootstrap/grid/over-view)
* [Documentation](https://ej2.syncfusion.com/javascript/documentation/grid/getting-started)
* [GraphQL with Syncfusion DataManager](https://ej2.syncfusion.com/javascript/documentation/grid/connecting-to-adaptors/web-method-adaptor)
Binary file added assets/images/adaptor-crud-operation.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/web-method-adaptor-value.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bed351b

Please sign in to comment.