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

EventStoreDB clients:

• C# - see more
• NodeJS - see more
• Java - see more
• Rust - see more

Local development

Documentation is written using VuePress.

Prerequisites

1. NodeJS installed (see installation guide).
2. Yarn installed (see installation guide).

Running docs locally

1. Clone the repo
2. Run yarn install
3. Run yarn docs:import
4. Run yarn docs:dev

Running production build

To run the production build that will import documentation from database and client repositories run:

yarn docs:build-prod

To import documentation from external repositories:

yarn docs:import

To build documentation without importing documentation:

yarn docs:build

Algolia Search

Documentation is using Algolia for indexing and searching through the contents.

To run Algolia search locally, create .algolia/.env file filled with contents based on the Algolia configuration:

ALGOLIA_APPLICATION_ID=
ALGOLIA_WRITE_API_KEY=
ALGOLIA_SITE_URL=
ALGOLIA_INDEX_NAME=
ALGOLIA_SEARCH_API_KEY=

Note: Make sure that you saved it with LF eol characters.

Scraping data locally

The scraping script uses a Docker, so you need to have Docker installed and running before running it.

Go to the .algolia folder and run the scrape.sh script.

Note: On windows we recommend to run the script in Git Bash.

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

1. EPERM: operation not permitted during yarn install - this error may appear if you've run the yarn install from Windows before running it on the WSL2. See troubleshooting link.
2. If yarn docs:dev fails, verify if your path does not contain spaces. We noticed some issues related to that.

Ubuntu

1. ERROR: There are no scenarios; must have at least one. while running yarn commands. Ubuntu has preinstalled cmdtest package that registers conflicting yarn. You might need to uninstall it and then configure yarn again. See troubleshooting link

Error: Cannot find module '../../server/generated/v21.2/docs/sidebar.js'

run yarn predocs:build