- Web UI for browsing and editing OpenClaw memory files - Cloned from https://github.com/silicondawn/memory-viewer - Built and running on port 8901 - Features: file tree, markdown rendering, search, live reload - Full access to MEMORY.md, daily notes, skills, automations
1.7 KiB
1.7 KiB
Contributing to Memory Viewer
Thanks for your interest in contributing! Here's how to get started.
Development Setup
- Prerequisites: Node.js >= 18, npm
- Clone and install:
git clone https://github.com/silicondawn/memory-viewer.git cd memory-viewer npm install - Start the dev server:
This runs both the API server and Vite dev server concurrently.
npm run dev
Submitting Pull Requests
- Fork the repo and create a feature branch from
master:git checkout -b feat/my-feature - Make your changes and ensure they pass type checking:
npm run typecheck - Commit with a clear message following Conventional Commits:
feat:for new featuresfix:for bug fixeschore:for maintenance tasksdocs:for documentation changes
- Push and open a PR against
master.
Code Style
- TypeScript — All new code should be written in TypeScript.
- React — Functional components with hooks.
- Tailwind CSS v4 — Use utility classes; avoid custom CSS when possible.
- Formatting — Keep lines reasonable (~100 chars). No trailing whitespace.
- Run
npm run typecheckbefore committing.
Reporting Issues
- Use the Bug Report or Feature Request templates.
- Include steps to reproduce, expected vs actual behavior, and your environment (OS, Node version, browser).
License
By contributing, you agree that your contributions will be licensed under the MIT License.