|
| 1 | +# React DataGrid |
| 2 | + |
| 3 | +## Installation |
| 4 | + |
| 5 | +To get started, first clone the repo: |
| 6 | + |
| 7 | +```bash |
| 8 | +git clone https://github.com/flexicious/react-datagrid |
| 9 | +``` |
| 10 | + |
| 11 | +Then install the dependencies: |
| 12 | +```bash |
| 13 | +npm install |
| 14 | +``` |
| 15 | + |
| 16 | +## Running the examples |
| 17 | + |
| 18 | +To run the examples, run the following command: |
| 19 | + |
| 20 | +```bash |
| 21 | +npm run start |
| 22 | +``` |
| 23 | +### Dashboard Example App |
| 24 | +This repo is a NX monorepo, which means it has multiple packages. The main package in this repo is the dashboard package. In this package, you will find all examples that are hosted on the [ReactDataGrid website](https://reactdatagrid.com/examples/). This is also the main package, so when you run `npm run start`, it will start the dashboard application. The dashboard application has no server side code, and is a pure React application. The api calls are mocked. |
| 25 | + |
| 26 | +### NextJS Example App with Knex and Sqlite |
| 27 | +The nextjs-knex-react example is a full stack application, with a server side API, and a client side React application. The server side API is built using [NextJS](https://nextjs.org/), and the database is [Sqlite](https://www.sqlite.org/index.html). The database is managed using [Knex](http://knexjs.org/). The client side application is built using React, and uses the ReactDataGrid component. The server side API is built using [NextJS](https://nextjs.org/), and the database is [Sqlite](https://www.sqlite.org/index.html). This example demonstrates a real world application with server side paging, filtering, sorting, and even a batched export/pdf functionality. |
| 28 | + |
| 29 | +To run the nextjs-knex-react example, run the following commands: |
| 30 | + |
| 31 | +```bash |
| 32 | +npx nx serve nextjs-knex-react |
| 33 | +``` |
| 34 | + |
| 35 | +This will start both the server side API, and the client side React application. Once the application is running, you can access the application at http://localhost:4200. |
| 36 | + |
| 37 | + |
| 38 | +### GraphQL Example App with Apollo Server and Apollo Client |
| 39 | +The graphql-apollo example is a full stack application, with a server side API, and a client side React application. The server side API is built using [Apollo Server](https://www.apollographql.com/docs/apollo-server/), and the database is [Sqlite](https://www.sqlite.org/index.html). The client side application is built using React, and uses the ReactDataGrid component. This example demonstrates a real world application with server side paging, filtering, sorting, and even a batched export/pdf functionality. |
| 40 | + |
| 41 | +To run the graphql-apollo example, run the following commands: |
| 42 | + |
| 43 | +```bash |
| 44 | +npx nx serve graphql-apollo-react |
| 45 | +``` |
| 46 | + |
| 47 | +This will start both the server side API, and the client side React application. Once the application is running, you can access the application at http://localhost:4200. |
| 48 | + |
| 49 | +## Documentation |
| 50 | +Getting Started Guide: |
| 51 | +https://reactdatagrid.com/docs/intro |
| 52 | +## Information |
| 53 | + |
| 54 | + |
| 55 | +- [ReactDataGrid](https://reactdatagrid.com) is a React component for displaying tabular data, built from the ground up for 2023, by a team with [20+ years](https://reactdatagrid.com/docs/welcome#a-trip-down-the-memory-lane) of experience building datagrids. |
| 56 | +- It integrates deeply with [Material UI](https://reactdatagrid.com/docs/welcome#material-ui-and-others), but thanks to its highly customizable rendering engine, it can be used with any UI framework, or without any UI framework at all. If you are already using Material UI, this datagrid will seamlessly integrate with your application in terms of user experience, theming, and customization. |
| 57 | +- It is very [light weight](https://reactdatagrid.com/docs/welcome#bundle-size) without compromising on features, thanks to a combination of [thoughtful design](https://reactdatagrid.com/docs/welcome#features), [modern tooling & ecosystem](https://reactdatagrid.com/docs/welcome#evolution-of-webpack-tree-shaking-and-es6-modules), [plugin architecture](https://reactdatagrid.com/docs/welcome#pluggability-over-configuration), and [ES6 modules](https://reactdatagrid.com/docs/welcome#evolution-of-webpack-tree-shaking-and-es6-modules). More on this below. |
| 58 | +- Built in React for React, with TypeScript. |
| 59 | + |
| 60 | + |
0 commit comments