Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

146 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🔺 Blackcode Issues

AI-native issue tracking with two surfaces over one data model: a web dashboard for humans, and the bk command-line tool for agents and scripts. Everything is workspace-scoped and built so that humans and the agents working alongside them can drive the same system.

  • Web — Next.js 16 App Router dashboard (/dashboard)
  • CLIbk, a Go binary published to npm as @blackcode_sa/bc-issues. The only supported programmatic interface. The REST routes under /api/* are private plumbing with no public contract — there is no published OpenAPI spec (see docs/cli.md, and CLAUDE.md for why).

For AI agents

npm install -g @blackcode_sa/bc-issues
bk login
bk skill install     # writes a ~30-line skill file for your coding agent
bk guide             # the complete usage guide for THIS binary — offline, no auth
bk meta              # your workspaces + live vocabularies + limits

bk guide ships inside the binary, so it always describes the version you are running. bk meta supplies everything that can change without a release. Those two are the only sources an agent needs.

Stack

Layer Choice
Framework Next.js 16 (App Router, React 18, TypeScript strict)
Styling Tailwind v4 (CSS-first, no tailwind.config), shadcn-style tokens in apps/issues/app/globals.css
Data PostgreSQL via Drizzle ORM (pg Pool)
Auth NextAuth (JWT) — email/password + optional Google OAuth; bk_live_… API tokens for the CLI/agents
Client data TanStack Query
Rich text TipTap (bubble + floating menus, @mentions)
Email Resend (optional — invitations + password-reset OTP)
Uploads Vercel Blob (optional — local public/uploads fallback in dev)

There is no separate MCP/companion server in this repo — the bk CLI is the integration surface. See docs/architecture-rebuild.md for the historical design record.

Going multi-app. The issue tracker is the first of several internal Blackcode apps (sales/CRM, bookkeeping, …), so this repo is now a monorepo: apps live in apps/*, the bk CLI and docs/ stay at the root, and Turborepo drives the tasks. The agreed target architecture — shared platform Postgres schema, per-app schemas, one bk CLI, cross-app links — is in PLATFORM-ARCHITECTURE.md, and the ordered migration in PLATFORM-MIGRATION-PLAN.md, with the pre-migration baseline in docs/migration/baseline.md.

Only Phases 0–1 have landed. There is no packages/platform-* yet, the CLI is not namespaced per app, and the database is still one public schema. Read those two documents before starting a second app or changing apps/issues/lib/db/schema.ts, apps/issues/lib/api/, apps/issues/lib/auth/ or cli/.

Quick start

1. Database

A docker-compose.yml boots Postgres 16 on localhost:5434 (db blackcode_issues, user blackcode, password blackcode_dev):

docker compose up -d

(Any reachable Postgres works — just point DATABASE_URL at it.)

2. Environment

Create apps/issues/.env.local (see ENV_TEMPLATE.md for the full list). It lives inside the app workspace, not at the repo root — Next and drizzle.config.ts both read it relative to apps/issues/.

The minimum to boot:

DATABASE_URL=postgres://blackcode:blackcode_dev@localhost:5434/blackcode_issues
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=$(openssl rand -base64 32)

Google OAuth, Resend email, and Vercel Blob are all optional — the app runs without them (email falls back to the in-app inbox + copyable links; uploads go to the local filesystem).

3. Install, migrate, run

All commands run from the repo root — this is an npm-workspaces + Turborepo monorepo, and the root scripts delegate into apps/issues.

npm install
npm run db:migrate    # apply Drizzle migrations in apps/issues/lib/db/migrations/
npm run dev

Visit http://localhost:3000. Sign up with email/password, and you'll be prompted to create your first workspace.

The scripts/*.sql files are legacy one-shot dumps. The source of truth for the schema is apps/issues/lib/db/schema.ts; migrations are managed by drizzle-kit (npm run db:generate to author one, npm run db:migrate to apply).

What's in the box

  • Workspaces — multi-tenant; every row is workspace_id-scoped. Owner + member roles. Issue IDs are a per-workspace sequence. Move or copy projects/tasks/issues between two workspaces you belong to — one atomic transaction, fresh #numbers, labels/comments/attachments carried, no data loss (bk move/bk copy, POST /api/workspaces/{ws}/move).
  • Projects — status, priority, lead, members, labels, start/target dates, icon, and a status-update feed (health: on-track / at-risk / off-track).
  • Issues — workspace sequence IDs, priority, status, assignee, labels, task, due dates, watchers, rich-text description, comments with @mentions, and attachments. Standalone issues (no project) are allowed.
  • Tasks — workspace- or project-scoped, with their own issues and comments.
  • Labels — defined at the workspace level, applied to issues and projects.
  • Activity & inbox — every mutation writes to an append-only event spine (events), which fans out into a per-user inbox and the activity feed.
  • Analytics — workspace / project / task / member views, with a print-to-PDF page.
  • Undo — a transaction log backs bk undo and the /api/undo endpoint.
  • Reliability — server-side error tracking with a public /status page.

API at a glance

Workspace-scoped routes are canonical:

/api/workspaces/{ws}/projects            GET, POST
/api/workspaces/{ws}/projects/{id}       GET, PATCH, DELETE
/api/workspaces/{ws}/projects/{id}/updates       GET, POST    # status updates
/api/workspaces/{ws}/issues              GET, POST
/api/workspaces/{ws}/issues/{id}         GET, PATCH, DELETE
/api/workspaces/{ws}/tasks …        GET, POST, PATCH, DELETE
/api/workspaces/{ws}/labels …            GET, POST, DELETE
/api/workspaces/{ws}/members …           GET, DELETE
/api/workspaces/{ws}/invitations …       GET, POST, DELETE
/api/workspaces/{ws}/activity            GET
/api/workspaces/{ws}/analytics           GET
/api/workspaces/{ws}/move                POST         # copy/move items to another workspace

Personal/auth routes live under /api/me/*, /api/auth/*, /api/tokens/*, /api/cli/authorize, /api/upload, /api/undo, and /api/status. A set of legacy non-workspace shims (/api/projects, /api/issues, /api/tasks, /api/users, /api/activity) remain for the CLI. Full detail in docs/backend.md.

{ws} accepts either a workspace slug or numeric id — prefer the slug (the numeric id is opaque; agents choose a workspace by name/slug from bk meta's workspaces list, never by id).

Authentication

  • Browser — NextAuth session cookie. Email/password (bcrypt) by default; Google OAuth if GOOGLE_CLIENT_ID/GOOGLE_CLIENT_SECRET are set.
  • API tokens — minted in Settings → Tokens or via the bk login browser flow, and sent by the CLI automatically. Stored as a SHA-256 hash; shown once. Token creation and revocation are session-only, so a leaked token can't mint more.
  • Password reset — OTP emailed via Resend; resetting a password invalidates existing browser sessions (API tokens are unaffected).

Documentation

Doc What it covers
docs/backend.md Internal. Schema, auth, private API routes, query layer, operations
docs/frontend.md Routes, theme system, shared components, data fetching
docs/cli.md Maintainer doc for the bk CLI — build, release, internals. Usage lives in bk guide
cli/internal/guide/topics/ The agent-facing usage guide, embedded in the binary and served by bk guide
docs/changelog/ The dated record of every change — one file per app plus platform.md, merged into one feed by bk changelog and GET /api/changelog
docs/marketing.md Positioning, feature catalog, voice
docs/architecture-rebuild.md, HANDOVER.md, docs/specs/* Historical design/planning records (point-in-time)

Deployment

Designed for Vercel. Set DATABASE_URL, NEXTAUTH_URL, NEXTAUTH_SECRET, and any optional integrations (GOOGLE_*, RESEND_*, BLOB_READ_WRITE_TOKEN) as environment variables, then run npm run db:migrate against the production database. Vercel auto-deploys on push.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages