File tree 1 file changed +12
-24
lines changed
1 file changed +12
-24
lines changed Original file line number Diff line number Diff line change @@ -23,6 +23,18 @@ A modular, modern SDK for working with YDB in JavaScript/TypeScript. Supports qu
23
23
24
24
## Quick Start
25
25
26
+ ### 1. Run YDB Locally
27
+
28
+ Start a local YDB instance with Docker: https://ydb.tech/docs/en/quickstart
29
+
30
+ ### 2. Install Required Packages
31
+
32
+ ``` sh
33
+ npm install @ydbjs/core @ydbjs/query
34
+ ```
35
+
36
+ ### 3. Connect and Query
37
+
26
38
``` ts
27
39
import { Driver } from ' @ydbjs/core'
28
40
import { query } from ' @ydbjs/query'
@@ -104,27 +116,3 @@ try {
104
116
105
117
- Build all packages: ` npm run build `
106
118
- Run all tests: ` npm test `
107
- - Build a single package: ` cd packages/query && npm run build `
108
- - Generate gRPC/protobuf files (for @ydbjs/api ): ` cd packages/api && npm run generate `
109
-
110
- Devcontainer setup includes YDB and Prometheus for local development. See ` .devcontainer/ ` for details.
111
-
112
- ---
113
-
114
- ## Contributing
115
-
116
- Contributions are welcome! Open issues, submit PRs, and discuss ideas.
117
-
118
- ---
119
-
120
- ## License
121
-
122
- Licensed under [ Apache 2.0] ( LICENSE ) .
123
-
124
- ---
125
-
126
- ## Links
127
-
128
- - [ YDB Documentation] ( https://ydb.tech )
129
- - [ GitHub Repository] ( https://github.com/ydb-platform/ydb-js-sdk )
130
- - [ Issues] ( https://github.com/ydb-platform/ydb-js-sdk/issues )
You can’t perform that action at this time.
0 commit comments