feat: bootstrap design kit and vaporwave demo baseline
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# UI Design Code
|
||||
|
||||
Submodule-first design-code kit for Go web applications and AI coding agents.
|
||||
|
||||
This repository is meant to be added to host projects as a git submodule and used to
|
||||
copy/sync canonical documentation, AI instruction templates, scaffolds, and UI pattern
|
||||
building blocks.
|
||||
|
||||
## Intended Usage
|
||||
|
||||
1. Add as submodule (recommended path: `tools/ui-design-code`)
|
||||
2. Use `tools/designsync` to list/plan/apply bundles into the host repo
|
||||
3. Review changes and commit in the host repo
|
||||
|
||||
## Public Surface (stable)
|
||||
|
||||
- `kit/`
|
||||
- `exports/`
|
||||
- `tools/designsync/`
|
||||
- `README.md`
|
||||
- `VERSIONING.md`
|
||||
- `CHANGELOG.md`
|
||||
|
||||
`demo/` is a runnable reference app and may change faster.
|
||||
|
||||
## Quick Start (this repo)
|
||||
|
||||
```bash
|
||||
go test ./...
|
||||
go build ./tools/designsync
|
||||
|
||||
cd demo
|
||||
go test ./...
|
||||
go run ./cmd/demo-server
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- Architecture source of truth: `bible/README.md`
|
||||
- AI instructions: `CLAUDE.md`, `AGENTS.md`
|
||||
|
||||
Reference in New Issue
Block a user