Skip to content

theiconik/koel

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

25 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

koel

AI voice-powered surveys.
Respondents speak instead of clicking. koel transcribes, surfaces themes, and gives you the thinking behind answers.


What it is

koel replaces multiple-choice surveys with open-ended voice conversations. A respondent clicks a link, speaks their answers, and koel handles transcription, theme clustering, and AI-powered insight queries β€” so survey creators get qualitative signal at scale.


Monorepo layout

koel/
  frontend/          Next.js 16 app (App Router, TypeScript, Tailwind v4)
  backend/           Python FastAPI service (in progress)
  koel-ui-design-system/   Figma-exported design tokens + reference components

Tech stack

Layer Technology
Frontend Next.js 16, React 19, TypeScript 5, Tailwind CSS v4
Auth Clerk (@clerk/nextjs v7)
Animations Framer Motion
Backend Python FastAPI (Supabase DB)
Design system Absans (display) + Manrope (body), CSS design tokens

Getting started

See frontend/docs/building-the-project.md for frontend setup, env vars, and scripts.

See backend/docs/building-the-project.md for backend setup, env vars, and scripts.

Where to look first

For AI agents and new developers β€” read in this order:

  1. frontend/CLAUDE.md β€” project rules, architecture decisions, known quirks (Clerk, Next.js 16 middleware, CSS tokens)
  2. frontend/docs/building-the-project.md β€” setup, env vars, route groups
  3. frontend/docs/code-conventions.md β€” folder structure, server/client component rules, styling conventions
  4. frontend/docs/wiring-with-mock-data.md β€” how the data layer works, how to add new data functions
  5. koel-ui-design-system/README.md β€” design tokens, palette, typography rules β€” read before touching any UI

Backend docs follow the same structure under backend/docs/ (being added as backend phases complete).


Contributing

  • Name is always koel, never Koel or KOEL.
  • Run npm run typecheck && npm run build before opening a PR β€” both must pass clean.
  • Check frontend/docs/issues-and-fixes.md for known issues before filing a new one.
  • UI Design questions β†’ koel-ui-design-system/README.md is the source of truth.
  • Backend Design questions β†’ backed/docs/architecture.md is the source of truth

About

πŸ¦β€β¬› AI voice based survey taking platform

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors