Skip to content

AI-driven changelog generator that turns commits into release notes.

License

Notifications You must be signed in to change notification settings

goosewin/chronicler

Repository files navigation

Chronicler

AI-driven changelog generator that turns Git history into readable release notes.

What it does

  • Connects to GitHub repositories
  • Groups commits into releases and project updates
  • Produces a public changelog page
  • Provides an admin UI for review and edits

Demo

https://chronicler-lake.vercel.app

Getting Started

  1. Clone the repository
    git clone https://github.com/goosewin/chronicler.git
    cd chronicler
  2. Install dependencies
    bun install
  3. Set up environment variables
    cp .env.example .env.local
  4. Set up the database
    bun db:push
  5. Run the development server
    bun dev

Environment Variables

OPENAI_API_KEY=
DATABASE_URL=
BETTER_AUTH_SECRET=
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=
NEXT_PUBLIC_BASE_URL=http://localhost:3000
VERCEL_TEAM_ID=
VERCEL_PROJECT_NAME=
VERCEL_TOKEN=

Commands

bun dev
bun run build
bun start
bun lint
bun format
bun db:generate
bun db:migrate
bun db:push
bun db:studio

Tech Stack

  • Next.js (App Router)
  • Neon (Postgres) + Drizzle ORM
  • BetterAuth
  • Vercel AI SDK + OpenAI
  • Tailwind CSS + shadcn/ui

License

MIT © Dan Goosewin

About

AI-driven changelog generator that turns commits into release notes.

Topics

Resources

License

Stars

Watchers

Forks