@x12i/memorix-explorer
v1.33.0
Published
React UI for Memorix Explorer — browses records, narratives, and collections via @x12i/memorix-explorer-api.
Readme
Memorix Explorer (UI)
React client for Memorix Explorer. Talks to @x12i/memorix-explorer-api over HTTP (/api/explorer/*).
Schema and descriptor administration for entities, relationships, and narratives lives in @x12i/memorix-schema-ui. List descriptors are managed here (exception) via /explorer/lists/*.
Default landing: /explorer/entities. Also: /explorer/lists, /explorer/api-docs.
Snapshot-capable records open a normalized snapshot inspector (discovery, analysis, associated copies). See docs/snapshot-associated-consumption.md.
Architecture
@x12i/memorix-explorer (this package, web/)
↓ fetch /api/explorer/*
@x12i/memorix-explorer-api (sibling package)
↓ @x12i/memorix-retrieval (reads)
↓ @x12i/memorix-descriptors (list descriptor writes)
↓ @x12i/memorix-writer (record writes)
MongoDB + CataloxQuick start
From the monorepo root, install both packages, then:
cd memorix-explorer-api
cp .env.example .env
npm install
npm run catalox:seed:memorix-retrieval:apply
cd ../memorix-explorer
npm install
npm run devOpen http://localhost:5173/explorer/entities.
npm run dev starts the API from memorix-explorer-api (port 5181) and Vite (port 5173).
Commands
| Script | Purpose |
|--------|---------|
| npm run dev | API (sibling) + Vite with HMR |
| npm run ui:dev | Vite only (expects API on 5181) |
| npm run build | Build static UI to dist/public |
| npm test | Typecheck + build |
| npm run test:live | Full-stack smokes (requires npm run dev) |
Environment (UI)
| Variable | Description |
|----------|-------------|
| VITE_MEMORIX_EXPLORER_API | Browser API base (default /api/explorer) |
| VITE_DEV_PORT | Vite port (default 5173) |
| EXPLORER_API_PORT | API proxy target port (default 5181) |
Mongo/Catalox env vars belong in memorix-explorer-api — see ../memorix-explorer-api/README.md.
Docs
| Document | Purpose |
|----------|---------|
| docs/schema-data-boundary.md | Schema vs data split |
| ../memorix-explorer-api/README.md | API server |
