You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -38,23 +39,24 @@ English | [简体中文](README-CN.md)
38
39
39
40
## 2. Documentation
40
41
41
-
- For development examples, see [Developer Guide](https://docs.tdengine.com/developer-guide/), which includes examples of data writing, querying, schemaless writing, parameter binding, and data subscription.
42
-
- For other reference information, see [Reference Manual](https://docs.tdengine.com/tdengine-reference/client-libraries/node/), which includes version history, data types, example programs, API descriptions, and FAQs.
42
+
- To use Node.js connector, please check [Developer Guide](https://docs.tdengine.com/developer-guide/), which includes how an application can introduce the `@tdengine/websocket`, as well as examples of data writing, querying, schemaless writing, parameter binding, and data subscription.
43
+
- For other reference information, please check [Reference Manual](https://docs.tdengine.com/tdengine-reference/client-libraries/node/), which includes version history, data types, example programs, API descriptions, and FAQs.
44
+
- This quick guide is mainly for developers who like to contribute/build/test the Node.js connector by themselves. To learn about TDengine, you can visit the [official documentation](https://docs.tdengine.com).
43
45
44
-
## 4. Prerequisites
46
+
## 3. Prerequisites
45
47
46
48
- Install the Node.js development environment, using version 14 or above. Download link: [https://nodejs.org/en/download/](https://nodejs.org/en/download/)
47
49
- Install the Node.js connector using npm.
48
50
- Install TypeScript 5.3.3 and above using npm.
49
-
- TDengine has been deployed locally. For specific steps, please refer to Deploy TDengine, and `taosd` and `taosAdapter` have been started.
51
+
- TDengine has been deployed locally. For specific steps, please refer to [Deploy TDengine](https://docs.tdengine.com/get-started/deploy-from-package/), and `taosd` and `taosAdapter` have been started.
50
52
51
-
## 5. Build
53
+
## 4. Build
52
54
53
55
Execute `tsc` to build the project in the 'nodejs' directory.
54
56
55
-
## 6. Testing
57
+
## 5. Testing
56
58
57
-
### 6.1 Test Execution
59
+
### 5.1 Test Execution
58
60
59
61
Execute `npm run test` in the project directory to run the tests. The test cases will connect to the local TDengine server and taosAdapter for testing.
60
62
After running the tests, the result similar to the following will be printed eventually. If all test cases pass, without any failures or errors.
@@ -67,15 +69,20 @@ Time: 20.373 s
67
69
Ran all test suites.
68
70
```
69
71
70
-
### 6.2 Test Case Addition
72
+
### 5.2 Test Case Addition
71
73
72
74
All tests are located in the `nodejs/test/bulkPulling` directory of the project. You can add new test files or add test cases in existing test files.
73
75
The test cases use the jest framework. Generally, a connection is established and a database is created in the `beforeAll` method, and the database is droped and the connection is released in the `afterAll` method.
We welcome the submission of [GitHub Issue](https://github.com/taosdata/taos-connector-node/issues/new?template=Blank+issue). When submitting, please provide the following information:
@@ -95,6 +102,7 @@ We welcome developers to contribute to this project. When submitting PRs, please
95
102
1. Modify the code, ensure all unit tests pass, and add new unit tests to verify the changes.
96
103
1. Push the changes to the remote branch (`git push origin my_branch`).
97
104
1. Create a Pull Request on GitHub ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)).
105
+
1. After submitting the PR, you can find your PR through the [Pull Request](https://github.com/taosdata/taos-connector-node/pulls). Click on the corresponding link to see if the CI for your PR has passed. If it has passed, it will display "All checks have passed". Regardless of whether the CI passes or not, you can click "Show all checks" -> "Details" to view the detailed test case logs.
98
106
1. After submitting the PR, if CI passes, you can find your PR on the [codecov](https://app.codecov.io/gh/taosdata/taos-connector-node/pulls) page to check the test coverage.
0 commit comments