EventStoreDB documentation
EventStoreDB is the open-source, functional database with Complex Event Processing in Javascript.
This repository contains documentation for both server and client SDK.
Contributing
Feel free to create a GitHub issue if you have any questions or request for more explanation or samples.
We're open for any contribution. If you noticed some inconsistency, missing piece, or you'd like to extend existing docs - we'll be happy to get your Pull Request.
Samples
GRPC Clients:
Local development
Documentation is written using VuePress.
Prerequisites
NodeJS
installed (see installation guide).Yarn
installed (see installation guide).
Running docs locally
- Clone the repo
- Run
yarn install
- Run
yarn docs:dev
Adding new programming language snippets
To add new language snippet it's needed to add import of Prism.JS plugin to VuePress plugins config, e.g.:
import "prismjs/components/prism-java";
Troubleshooting
Windows
EPERM: operation not permitted
duringyarn install
- this error may appear if you've run theyarn install
from Windows before running it on the WSL2. See troubleshooting link.
Ubuntu
ERROR: There are no scenarios; must have at least one.
while runningyarn
commands. Ubuntu has preinstalledcmdtest
package that registers conflictingyarn
. You might need to uninstall it and then configure yarn again. See troubleshooting link