summaryrefslogtreecommitdiff
path: root/README.nfo
blob: ead071d20b17678d1499b8591e100752adc09b46 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
┌──────────────────────────────────────────────────────────────┐
│  B R A N D   B E N C H                     [ KRZ ]   krz.sh  │
└──────────────────────────────────────────────────────────────┘

WHAT
  client-side brand identity generator. describe a project, get a
  brand package: positioning, tone, color palette, typography, logo
  concepts, taglines, usage examples. runs in the browser.

  no backend. no accounts. state persists in localStorage.

DOES
  - template generation, offline, tailored by category
  - ai generation via a local ollama instance, cancellable mid-stream
  - multiple packages in tabs, each persisted separately
  - inline editing, click any field in the preview
  - section locking across regenerations
  - undo/redo per package (⌘Z / ⌘⇧Z)
  - editable color swatches, native color picker
  - font pairings per category, 8-level type scale
  - export to markdown, json, or a self-contained html page

RUN
      npm install
      npm run dev

  open http://localhost:5173.

  build:

      npm run build      # dist/
      npm run preview

AI WITH OLLAMA
  1. install ollama, pull a model:

         ollama pull llama3.2
         ollama pull mistral
         ollama pull gemma3

  2. run it:

         ollama serve

  3. a non-default host or port needs OLLAMA_ORIGINS set for browser
     requests:

         OLLAMA_ORIGINS="*" ollama serve

  4. in the app: Settings, enable AI, set base url
     (http://localhost:11434), pick a model, Test connection.

  bigger models give better-structured output. generation takes
  15-60s depending on hardware.

DOCKER
  Dockerfile and compose.yml deploy the app next to ollama.

      docker compose up -d --build

  app serves on port 8000. ollama's api is proxied through nginx at
  /api/, so the browser makes no cross-origin request. after first
  boot, pull a model:

      docker compose exec ollama ollama pull llama3.2

  set the ollama base url to http://your-server:8000. for an nvidia
  gpu, uncomment the deploy block in compose.yml (needs the nvidia
  container toolkit).

STACK
  react 18, typescript, vite. no ui library, plain css.

LICENSE
  0bsd. see LICENSE.

┌──────────────────────────────────────────────────────────────┐
│  krz.sh                                                      │
└──────────────────────────────────────────────────────────────┘