Skip to content

Commit 8c19b0f

Browse files
committed
add Quick Start for Win/MacOS
1 parent 943aa6a commit 8c19b0f

File tree

1 file changed

+39
-13
lines changed

1 file changed

+39
-13
lines changed

README.md

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,36 +8,37 @@ GridDB Node API is developed using GridDB C Client and [node-addon-api](https://
88

99
Building of the library and execution of the sample programs have been checked in the following environment.
1010

11-
OS: CentOS 7(x64)/Ubuntu 18.04(x64)
11+
OS: CentOS 7(x64)/Ubuntu 18.04(x64)/Windows 10/MacOS 10.15
1212
Node.js: v12
1313
GridDB C client: V4.5 CE
1414
GridDB server: V4.5 CE, CentOS 7.6(x64)
1515

16-
## QuickStart (CentOS 7/Ubuntu 18.04(x64))
17-
18-
### Preparations
16+
## Preparations
1917

2018
Install [GridDB Server](https://github.com/griddb/griddb) and [C Client](https://github.com/griddb/c_client).
2119

22-
Set LIBRARY_PATH.
23-
24-
export LIBRARY_PATH=$LIBRARY_PATH:<C client library file directory path>
20+
## QuickStart (CentOS 7/Ubuntu 18.04(x64)/MacOS 10.15)
2521

2622
### Build
27-
1. The command to run build project
28-
$ npm install
23+
1. Set LIBRARY_PATH.
2924

30-
2. Set the NODE_PATH variable for griddb Node.js module files.
25+
export LIBRARY_PATH=$LIBRARY_PATH:<C client library file directory path>
3126

32-
$ export NODE_PATH=<installed directory path>
27+
2. The command to run build project
3328

34-
3. Write require("griddb-node-api") in Node.js.
29+
$ npm install
30+
31+
3. Set the NODE_PATH variable for griddb Node.js module files.
32+
33+
$ export NODE_PATH=<installed directory path>
34+
35+
4. Write require("griddb-node-api") in Node.js.
3536

3637
### How to run sample
3738

3839
GridDB Server need to be started in advance.
3940

40-
1. Set LD_LIBRARY_PATH
41+
1. Set LD_LIBRARY_PATH.
4142

4243
export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:<C client library file directory path>
4344

@@ -47,6 +48,31 @@ GridDB Server need to be started in advance.
4748
<GridDB cluster name> <GridDB user> <GridDB password>
4849
-->[ 'name01', false, 1, <Buffer 41 42 43 44 45 46 47 48 49 4a> ]
4950

51+
## QuickStart (Windows 10)
52+
53+
### Build and run in cmd
54+
1. Correct the path to C Client "C_CLIENT_PATH" in binding.gyp. Default is 'C:/Program Files/GridDB/C Client/4.5.0'
55+
56+
2. The command to run build project
57+
58+
$ npm install
59+
60+
3. Set the NODE_PATH variable for griddb Node.js module files.
61+
62+
$ set NODE_PATH=<installed directory path>
63+
64+
3. Write require("griddb-node-api") in Node.js.
65+
66+
### How to run sample
67+
68+
GridDB Server need to be started in advance.
69+
70+
1. The command to run sample
71+
72+
$ node sample/sample1.js <GridDB notification address> <GridDB notification port>
73+
<GridDB cluster name> <GridDB user> <GridDB password>
74+
-->[ 'name01', false, 1, <Buffer 41 42 43 44 45 46 47 48 49 4a> ]
75+
5076
## Document
5177

5278
- [Node API Reference](https://griddb.github.io/node-api/NodeAPIReference.htm)

0 commit comments

Comments
 (0)