Skip to content

Commit 70e6a67

Browse files
authored
Update README.md
1 parent bd4f650 commit 70e6a67

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,33 @@
11
# WebDataRocks integration with React framework
22

3-
This repository holds sample integration project of WebDataRocks reporting tool with React framework.
3+
This repository holds a sample integration project of WebDataRocks reporting tool with the React framework.
44

5-
## How to run the project
5+
## Get WebDataRocks
66

7+
WebDataRocks is a free reporting tool. [Get it here](https://www.webdatarocks.com/get-webdatarocks/).
8+
9+
## Run this project
10+
11+
1. Download or clone this sample project from GitHub:
12+
- Get React + ES6 project:
13+
14+
```
15+
git clone https://github.com/WebDataRocks/pivot-react && cd pivot-react/ES6
16+
```
17+
- Get React + TypeScript project:
18+
```
19+
git clone https://github.com/WebDataRocks/pivot-react && cd pivot-react/typescript
20+
```
21+
3. Install npm packages by running in the console:
722
```
823
npm install
24+
```
25+
3. Run your application:
26+
```
927
npm start
1028
```
29+
Your application will run at `http://localhost:3000/`.
30+
31+
## Learn more about integration with React
32+
33+
For detailed instructions on the integration, please refer to this tutorial: [WebDataRocks integration with React](https://www.webdatarocks.com/doc/integration-with-react/).

0 commit comments

Comments
 (0)