james.maes
ff2104eb50
Three npm packages (create-jarvis-file CLI, jarvis-file-core browser framework, jarvis-file-backend AI services), starter HTML templates, design system CSS, CI/CD workflows, docs stubs, and design specs.
2.8 KiB
2.8 KiB
Jarvis File
Interactive AI-assisted design documents. Deploy a fully functional, AI-powered design review site to your own Firebase project in under 30 minutes.
What You Get
- Authentication gate -- Google sign-in restricted to your domain
- Threaded comments -- @mentions, resolve/reopen, typing indicators, real-time sync
- AI design assistant -- monitors comments, responds with contextual intelligence, files change requests
- Automated change processor -- Claude Agent SDK implements approved changes, commits, deploys
- Full-text search -- Cmd+K cross-document search with highlighted results and deep linking
- Version tracking -- revision dropdown, version history, archived snapshots
- Dark-theme design system -- cards, grids, stat boxes, badges, tables, responsive breakpoints
- Starter templates -- Executive Summary, System Design, Implementation Plan, Business Review, Presentation
Quick Start
npx @koftwentytwo/create-jarvis-file my-project
cd my-project
firebase deploy
cd jarvis && npm install
ANTHROPIC_API_KEY=sk-... npm start
Then open https://my-project.web.app.
Packages
| Package | Description |
|---|---|
@koftwentytwo/create-jarvis-file |
CLI generator -- interactive prompts, file scaffolding |
@koftwentytwo/jarvis-file-core |
Browser framework -- auth gate, comments, search, chat, design system CSS |
@koftwentytwo/jarvis-file-backend |
Node.js AI services -- comment monitor, chat responder, change processor |
How It Works
Jarvis File extracts the battle-tested interactive design document platform built for Praesidium2 into a reusable open source product. The CLI generator scaffolds a complete project with your configuration, and the framework JS reads everything from a single jarvis-file.config.js file.
Documentation
- Getting Started -- zero-to-deployed walkthrough
- Configuration -- full config schema reference
- Design System -- CSS component guide
- Jarvis Backend -- AI backend setup and persona customization
- Templates -- template customization guide
- FAQ -- Firebase setup, auth issues, cost estimation
Tech Stack
- Hosting: Firebase Hosting (static HTML)
- Database: Cloud Firestore (real-time comments, chat, change requests)
- Auth: Firebase Auth (Google sign-in)
- AI: Anthropic Claude (chat responses, change implementation)
- Agent: Claude Agent SDK (automated change processor)
Cost
Typical cost for a 10-person review team: $0-15/month (mostly within Firebase free tiers, plus Anthropic API usage based on comment volume).
License
MIT