mirror of
https://github.com/purrgrammer/grimoire.git
synced 2026-04-08 22:47:02 +02:00
f22cfc930f
* Add README.md with project overview and getting started guide * Remove inaccurate offline support claim from README --------- Co-authored-by: Claude <noreply@anthropic.com>
36 lines
829 B
Markdown
36 lines
829 B
Markdown
# Grimoire
|
|
|
|
A Nostr protocol explorer and developer tool with a tiling window manager interface.
|
|
|
|
## Features
|
|
|
|
- **Tiling Windows** - Each window is a Nostr "app" (profile viewer, event feed, NIP docs, etc.)
|
|
- **Command Palette** - Unix-style commands via `Cmd+K` to open apps and navigate
|
|
- **Multi-workspace** - Virtual desktops with independent layouts
|
|
- **Real-time** - Reactive event subscriptions with automatic updates
|
|
|
|
## Stack
|
|
|
|
React 19, TypeScript, Vite, TailwindCSS, Jotai, Dexie, Applesauce
|
|
|
|
## Getting Started
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
## Scripts
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `npm run dev` | Start dev server |
|
|
| `npm run build` | Build for production |
|
|
| `npm test` | Run tests in watch mode |
|
|
| `npm run lint` | Lint code |
|
|
| `npm run format` | Format code |
|
|
|
|
## License
|
|
|
|
MIT
|