Developer DocumentationFolder Structure

Folder Structure

This overview explains where core app code lives and where new features should be added in the repository.

Full tree overview

event-slot/
  app/                    Next.js App Router routes and layouts
    (attendee)/           attendee-facing route group
    (auth)/               auth pages and flows
    (organizer)/          organiser dashboard route group
    admin/                super-admin UI
    api/                  route handlers (backend APIs)
    [username]/           public organiser and event slug routes
  components/             reusable UI components
  hooks/                  custom React hooks
  lib/                    server/client utilities and integrations
  prisma/                 schema and migrations
  public/                 static assets and PWA files
  scripts/                utility and ops scripts
  docs/                   canonical platform docs
  docs-site/              external documentation website
  middleware.ts           NextAuth route protection
  cloudbuild.yaml         Cloud Build deployment config
  Dockerfile              production container build

Where to add new code

NeedLocation
New UI pageapp/<route>/page.tsx
New API endpointapp/api/<domain>/route.ts
Shared componentcomponents/<FeatureName>.tsx
Shared helperlib/<name>.ts
Data model changeprisma/schema.prisma + migration

Naming conventions

  • Route folders: kebab-case or route segment syntax
  • Components: PascalCase
  • Utility modules: camelCase or domainName.ts
  • API route folders: domain-oriented, singular where practical