Skip to content

Commit 2cd84ef

Browse files
authored
Update README.md
1 parent f7e642c commit 2cd84ef

File tree

1 file changed

+24
-18
lines changed

1 file changed

+24
-18
lines changed

README.md

+24-18
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
1-
# WebDataRocks integration with React framework
1+
# Example of integrating WebDataRocks with the React framework
22

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/).
44

5-
- [Get WebDataRocks](#get-webdatarocks)
6-
- [Run this project](#run-project)
7-
- [Learn more about integration with React](#learn-more)
5+
## Prerequisites
86

9-
<h2 id="get-webdatarocks">Get WebDataRocks</h2>
7+
For React + ES6 project:
8+
- [Node.js 6 or later](https://nodejs.org/en/)
109

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/)
1212

13-
<h2 id="run-project">Run this project</h2>
1413

15-
1. Download or clone this sample project from GitHub:
16-
- Get React + ES6 project:
14+
## Run the project
1715

16+
1. Download or clone this project from GitHub:
17+
- React + ES6 project:
1818
```
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
2021
```
21-
- Get React + TypeScript project:
22+
- React + TypeScript project:
2223
```
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
2426
```
25-
3. Install npm packages by running in the console:
27+
2. Install npm packages:
2628
```
2729
npm install
2830
```
29-
3. Run your application:
31+
3. Run the project:
3032
```
3133
npm start
3234
```
33-
Your application will run at `http://localhost:3000/`.
35+
You can access the project at `http://localhost:3000/`.
3436
35-
<h2 id="learn-more">Learn more about integration with React</h2>
37+
## Related docs
3638
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

Comments
 (0)