Files
books/README.md
T
rmcampos 520e55563d
Frontend CD / build (push) Successful in 5m21s
chore: update docs and bump dependencies
2026-06-25 10:02:27 -03:00

1.9 KiB

Bookshelf

License: GPL v3 Frontend Build

A personal book wishlist app built to learn Convex deeply.

Stack: TanStack Start · Convex · Clerk · Tailwind CSS · shadcn/ui

Getting started

Prerequisites

  • Node.js 20+
  • A Convex account
  • A Clerk account with a JWT template named convex

Setup

npm install

# Start the Convex dev server (writes CONVEX_DEPLOYMENT + VITE_CONVEX_URL to .env.local)
npx convex dev

# In a separate terminal, start the frontend
npm run dev

Copy .env.example to .env.local and fill in:

VITE_CLERK_PUBLISHABLE_KEY=pk_test_...
CLERK_SECRET_KEY=sk_test_...
VITE_CONVEX_URL=https://...convex.cloud
CONVEX_DEPLOYMENT=dev:...

Project structure

convex/       Convex backend (schema, queries, mutations, actions, crons)
src/
  routes/     TanStack Start file-based routes
  integrations/
    clerk/    ClerkProvider wrapper
    convex/   ConvexProviderWithClerk wrapper
ai/           Project context, specs, and AI workflow documentation

Implementation plan

See ai/specs/ for the full spec list. Progress is tracked in ai/context/current_milestone.md.

Spec Feature Status
001 Scaffold (auth + Convex wired up) done
002 Core wishlist (Book Entry CRUD) done
003 Book search via Google Books API done
004 Shelves (custom collections) done
005 Ratings and reviews done
006 Cover image upload (Convex file storage) done
007 Stale reading reminder (Convex cron) pending