Skip to content

Commit da473b8

Browse files
authored
Update README.md
1 parent 59632e5 commit da473b8

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

typescript/README.md

+26-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,31 @@
1-
# WebDataRocks integration with React + Typescript framework
1+
# WebDataRocks integration with React + TypeScript
22

3-
This repository holds sample integration project of WebDataRocks reporting tool with React + Typescript framework.
3+
This repository contains a sample TypeScript project that shows how to integrate [WebDataRocks](https://www.webdatarocks.com/) with the [React framework](https://react.dev/).
44

5-
## How to run the project
5+
## Prerequisites
66

7+
- [Node.js 8 through 16](https://nodejs.org/en/)
8+
9+
## Run the project
10+
11+
1. Download or clone this project from GitHub:
12+
```
13+
git clone https://github.com/WebDataRocks/pivot-react
14+
cd pivot-react/typescript
15+
```
16+
2. Install npm packages:
17+
```
18+
npm install
719
```
8-
yarn install
9-
yarn start
20+
3. Run the project:
1021
```
22+
npm start
23+
```
24+
You can access the project at `http://localhost:3000/`.
25+
26+
## Related docs
27+
28+
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/).
29+
30+
## Support
31+
Feel free to ask WebDataRocks-related questions on [StackOverflow](https://stackoverflow.com/questions/tagged/webdatarocks).

0 commit comments

Comments
 (0)