68 lines
1.7 KiB
Markdown
68 lines
1.7 KiB
Markdown
# Reanimator Chart
|
|
|
|
`chart` is a small read-only web viewer for Reanimator hardware JSON snapshots.
|
|
|
|
It is intended to be embedded into other Go applications that collect audit data in different ways and want a consistent HTML view of the resulting Reanimator JSON.
|
|
|
|
## Integration
|
|
|
|
For embedding instructions, see [`docs/embedding.md`](/Users/mchusavitin/Documents/git/reanimator/chart/docs/embedding.md).
|
|
|
|
### As Git Submodule
|
|
|
|
To embed `chart` into another repository as a git submodule:
|
|
|
|
```bash
|
|
git submodule add https://git.mchus.pro/reanimator/chart.git internal/chart
|
|
git submodule update --init --recursive
|
|
```
|
|
|
|
In the host application's `go.mod`, point the module path at the checked-out submodule:
|
|
|
|
```go
|
|
replace reanimator/chart => ./internal/chart
|
|
```
|
|
|
|
Example mount inside the host application:
|
|
|
|
```go
|
|
mux.Handle("/chart/", http.StripPrefix("/chart", viewer.NewHandler(viewer.HandlerOptions{
|
|
Title: "Hardware Snapshot",
|
|
})))
|
|
```
|
|
|
|
To update the submodule later:
|
|
|
|
```bash
|
|
git submodule update --remote internal/chart
|
|
git add internal/chart
|
|
git commit -m "Update reanimator chart submodule"
|
|
```
|
|
|
|
Standalone local run:
|
|
|
|
```bash
|
|
make run
|
|
```
|
|
|
|
## Product Scope
|
|
|
|
- render a Reanimator JSON snapshot as HTML
|
|
- preserve the source payload shape
|
|
- show all fields from JSON
|
|
- use compact tables and section navigation
|
|
- color statuses for quick scanning
|
|
|
|
## Explicit Non-Goals
|
|
|
|
- no ingest pipeline
|
|
- no audit collection
|
|
- no background jobs
|
|
- no summary generation beyond what already exists in JSON
|
|
- no mutation of the input data
|
|
- no vendor-specific parsing logic
|
|
|
|
## Architecture Docs
|
|
|
|
Project-specific architecture lives in [`bible-local/README.md`](/Users/mchusavitin/Documents/git/reanimator/chart/bible-local/README.md).
|