https://github.com/kurrent-io/kurrentdb-client-nodejs
KurrentDB NodeJS Client
https://github.com/kurrent-io/kurrentdb-client-nodejs
cqrs event-sourcing eventsourcing grpc javascript kurrent kurrentdb nodejs typescript
Last synced: 21 days ago
JSON representation
KurrentDB NodeJS Client
- Host: GitHub
- URL: https://github.com/kurrent-io/kurrentdb-client-nodejs
- Owner: kurrent-io
- License: other
- Created: 2019-11-20T10:23:28.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T16:00:36.000Z (about 1 month ago)
- Last Synced: 2025-04-06T11:50:13.829Z (27 days ago)
- Topics: cqrs, event-sourcing, eventsourcing, grpc, javascript, kurrent, kurrentdb, nodejs, typescript
- Language: JavaScript
- Homepage: https://kurrent.io
- Size: 13.8 MB
- Stars: 164
- Watchers: 31
- Forks: 24
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# KurrentDB NodeJS Client
[](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_previous_LTS.yml)
[](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_LTS.yml)
[](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/actions/workflows/test_next.yml)
KurrentDB is a database that's engineered for modern software applications and event-driven architectures. Its
event-native design simplifies data modeling and preserves data integrity while the integrated streaming engine solves
distributed messaging challenges and ensures data consistency.
### Documentation
* [API Reference](https://pkg.go.dev/github.com/kurrent.io/KurrentDB-Client-Go?tab=doc)
* [Samples](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/tree/master/samples)
## Packages
This monorepo contains the following packages:
| Subfolder | Package |
| ---------------------------------------------------- | -------------------------------------------------------------------------------------- |
| [`packages/db-client/`](packages/db-client/) | [`@kurrent/kurrentdb-client`](https://www.npmjs.com/package/@kurrent/kurrentdb-client) |
| [`packages/opentelemetry/`](packages/opentelemetry/) | [`@kurrent/opentelemetry`](https://www.npmjs.com/package/@kurrent/opentelemetry) |
| [`packages/test/`](packages/test/) | Internal tests |
The client uses [KurrentDB-Bridge-Client](https://github.com/kurrent-io/EventStore-Client-NodeJS)
to significantly improve read performance by leveraging Rust through native addons.
## Communities
[Join our global community](https://www.kurrent.io/community) of developers.
- [Discuss](https://discuss.kurrent.io/)
- [Discord (Kurrent)](https://discord.gg/Phn9pmCw3t)
- [Discord (ddd-cqrs-es)](https://discord.com/invite/sEZGSHNNbH)
## Contributing
Development is done on the `master` branch.
We attempt to do our best to ensure that the history remains clean and to do so, we generally ask contributors to squash
their commits into a set or single logical commit.
- [Create an issue](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/issues)
- [Documentation](https://docs.kurrent.io/)
- [Contributing guide](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/blob/master/CONTRIBUTING.md)
## Building the client
The client is built using the [NodeJS](https://nodejs.org/) JavaScript runtime. To build the client, you need to have Node
installed on your machine. You can download it from the official NodeJS website.
Once you have it installed, you can build the client by running the following command in the root directory of the
project:
```bash
yarn install
yarn build
```