feat(eventsourcingdb): adds package for EventSourcingDB

.github/workflows/checks.yaml

@@ -14,24 +14,16 @@ jobs:
   deploy:
     name: Format, Lint, Type Check & Test
     runs-on: ubuntu-latest
-    env:
-      DENO_DIR: deno_cache_dir
-
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
 
-      - name: Cache Deno dependencies
-        uses: actions/cache@8b402f58fbc84540c8b491a91e594a4576fec3d7
-        with:
-          path: ${{ env.DENO_DIR }}
-          key: deno-${{ runner.os }}-${{ hashFiles('deno.lock') }}
-          restore-keys: |
-            deno-${{ runner.os }}-
-
       - uses: denoland/setup-deno@e95548e56dfa95d4e1a28d6f422fafe75c4c26fb
         with:
           deno-version: v2
 
+      - name: Install dependencies
+        run: deno install --frozen
+
       - name: Check formatting
         run: deno fmt --check
 

.github/workflows/publish.yaml

@@ -35,3 +35,7 @@ jobs:
       - name: Publish utils package
         working-directory: ./packages/utils
         run: deno publish
+
+      - name: Publish eventsourcingdb package
+        working-directory: ./packages/eventsourcingdb
+        run: deno publish

.gitignore

@@ -45,3 +45,9 @@ testem.log
 Thumbs.db
 
 .nx/cache
+
+# Claude Code
+.claude/settings.local.json
+
+# EventSourcingDB
+esdb-data/

CLAUDE.md

@@ -1,10 +1,25 @@
+# Add and adjust tests
+
+Whenever new functionality is added, add tests for it afterwards.
+
+When functionality is changed, adjust the tests or add new test cases accordingly.
+
+# Documentation
+
+Documentation is handled in two ways:
+
+-   Technical documentation as JSDoc comments in the code. This is mandatory for all publicly exported elements so JSR can generate documentation based on it.
+-   User documentation in the docs folder. This is targeted for users in a more guided way.
+
+Make sure to update the documentation when functionality is changed or added.
+
 # Format, Lint, Type Check & Test
 
-Whenever something is changed in the examples or packages, run the following commands to format, lint, type check and test the code. Running these commands from the repository root will check all examples and packages.
+Whenever something is changed in the examples or packages, run the following commands to type check, format, lint and test the code. Running these commands from the repository root will check all examples and packages.
 
 ```
+deno check
 deno fmt --check
 deno lint
-deno check
-deno test
+deno test --allow-all
 ```

DEVELOPMENT.md

@@ -0,0 +1,37 @@
+# EventSourcingDB
+
+To use the EventSourcingDB for testing and development purposes, you can use the following commands and find all the details in the [EventSourcingDB documentation](https://docs.eventsourcingdb.io/).
+
+**Install EventSourcingDB**
+
+```bash
+docker pull thenativeweb/eventsourcingdb
+```
+
+**Start EventSourcingDB with temporary data**
+
+```bash
+docker run -it -p 3000:3000 \
+  thenativeweb/eventsourcingdb run \
+  --api-token=secret \
+  --data-directory-temporary \
+  --http-enabled \
+  --https-enabled=false \
+  --with-ui
+```
+
+**Start EventSourcingDB with persistent data**
+
+The data will be stored in the `esdb-data` directory which is ignored by Git.
+
+```bash
+docker run -it \
+  -p 3000:3000 \
+  -v ./esdb-data:/var/lib/esdb \
+  thenativeweb/eventsourcingdb run \
+  --api-token=secret \
+  --data-directory=/var/lib/esdb \
+  --http-enabled \
+  --https-enabled=false \
+  --with-ui
+```

deno.json

@@ -10,7 +10,9 @@
     "./packages/mongodb",
     "./packages/hono",
     "./packages/utils",
-    "./examples/hono-demo"
+    "./packages/eventsourcingdb",
+    "./examples/hono-demo",
+    "./examples/eventsourcing-demo"
   ],
   "nodeModulesDir": "none",
   "fmt": {