c56a5218b8
## Description Updates our transitive dependencies on `path-to-regexp` to versions that fixed https://nvd.nist.gov/vuln/detail/CVE-2024-45296 . Accomplished by updating our direct dependencies on `sinon` to a mix of version 18 and 19, since that's the main way in which we get transitive dependencies on `path-to-regexp`. `@types/sinon` was also opportunistically updated to the latest version where it wasn't already up to date. |
||
|---|---|---|
| .. | ||
| .vscode | ||
| packages | ||
| scripts | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitignore | ||
| .npmignore | ||
| .npmrc | ||
| .prettierignore | ||
| .releaseGroup | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| lerna.json | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| prettier.config.cjs | ||
README.md
historian
The historian service tracks the historical record for a document. It serves as a proxy to the underlying git repository that maintains the versioned snapshots.
Building and running
For consistency we recommend building and developing within a container
You can build the production container by running.
docker build -t historian .
And then mount it for development by running.
docker run -it -v "$(pwd):/home/node/server" -p 3000:3000 node:8.15.0-slim /bin/bash
When mounted for development you'll want to run the following commands. These also work if you would like to develop outside of the container.
npm install -g pnpm
pnpm i
npm run build
Compose
A compose file is also provided which provides a Redis server and a Git REST server. By default it will mount your local files into the container so you will need to npm install, npm run build prior.
Testing
docker run -t historian npm test
Trademark
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.