|
1 |
| -# WebDataRocks integration with React framework |
| 1 | +# Example of integrating WebDataRocks with the React framework |
2 | 2 |
|
3 |
| -This repository holds a sample integration project of WebDataRocks reporting tool with the React framework. |
| 3 | +This repository contains sample ES6 and TypeScript projects that show how to integrate [WebDataRocks](https://www.webdatarocks.com/) with the [React framework](https://react.dev/). |
4 | 4 |
|
5 |
| -- [Get WebDataRocks](#get-webdatarocks) |
6 |
| -- [Run this project](#run-project) |
7 |
| -- [Learn more about integration with React](#learn-more) |
| 5 | +## Prerequisites |
8 | 6 |
|
9 |
| -<h2 id="get-webdatarocks">Get WebDataRocks</h2> |
| 7 | +For React + ES6 project: |
| 8 | +- [Node.js 6 or later](https://nodejs.org/en/) |
10 | 9 |
|
11 |
| -WebDataRocks is a free reporting tool. [Get it here](https://www.webdatarocks.com/get-webdatarocks/). |
| 10 | +For React + TypeScript project: |
| 11 | +- [Node.js 8 through 16](https://nodejs.org/en/) |
12 | 12 |
|
13 |
| -<h2 id="run-project">Run this project</h2> |
14 | 13 |
|
15 |
| -1. Download or clone this sample project from GitHub: |
16 |
| - - Get React + ES6 project: |
| 14 | +## Run the project |
17 | 15 |
|
| 16 | +1. Download or clone this project from GitHub: |
| 17 | + - React + ES6 project: |
18 | 18 | ```
|
19 |
| - git clone https://github.com/WebDataRocks/pivot-react && cd pivot-react/ES6 |
| 19 | + git clone https://github.com/WebDataRocks/pivot-react |
| 20 | + cd pivot-react/ES6 |
20 | 21 | ```
|
21 |
| - - Get React + TypeScript project: |
| 22 | + - React + TypeScript project: |
22 | 23 | ```
|
23 |
| - git clone https://github.com/WebDataRocks/pivot-react && cd pivot-react/typescript |
| 24 | + git clone https://github.com/WebDataRocks/pivot-react |
| 25 | + cd pivot-react/typescript |
24 | 26 | ```
|
25 |
| -3. Install npm packages by running in the console: |
| 27 | +2. Install npm packages: |
26 | 28 | ```
|
27 | 29 | npm install
|
28 | 30 | ```
|
29 |
| -3. Run your application: |
| 31 | +3. Run the project: |
30 | 32 | ```
|
31 | 33 | npm start
|
32 | 34 | ```
|
33 |
| -Your application will run at `http://localhost:3000/`. |
| 35 | +You can access the project at `http://localhost:3000/`. |
34 | 36 |
|
35 |
| -<h2 id="learn-more">Learn more about integration with React</h2> |
| 37 | +## Related docs |
36 | 38 |
|
37 |
| -For detailed instructions on the integration, please refer to this tutorial: [Integration with React](https://www.webdatarocks.com/doc/integration-with-react/). |
| 39 | +For details on how to integrate WebDataRocks into existing React projects, check out the [integration with React](https://www.webdatarocks.com/doc/integration-with-react/). |
| 40 | +
|
| 41 | +## Support |
| 42 | +
|
| 43 | +Feel free to ask WebDataRocks-related questions on [StackOverflow](https://stackoverflow.com/questions/tagged/webdatarocks). |
0 commit comments