How fuma-nama/fumadb works
Project type and purpose
• This is an open-source TypeScript monorepo, managed with pnpm and Turborepo.
• It contains:
• FumaDB: a unified database API library for other libraries (packages/fumadb).
• Documentation site: a Next.js app under apps/docs.
• Example apps: simple usage under examples/basic.
• Purpose: Provide a single API surface over multiple ORMs/adapters (Prisma, Drizzle, TypeORM, Kysely, MongoDB, Convex), plus CLI tools, schema generation/migration, and query building.
File structure
• Root
• pnpm-workspace.yaml, turbo.json: orchestrate tasks across workspaces.
• CI workflows (.github/workflows): lint, test, release.
• apps/docs
• Next.js 13+ app directory (app/, components/, content/, lib/).
• Serves documentation pages, MDX content.
• examples/basic
• A minimal consumer project showing integration with FumaDB and adapters.
• packages/fumadb
• Core library code under src/:
– adapters/: adapter implementations for each ORM.
– query/: condition builders, ORM-specific query implementations, polyfills.
– schema/: introspection, migration, generation, serialization.
– cli/: command-line interface entrypoint.
– shared, utils: common utilities.
• Tests under test/.
• Config (tsup, vitest, tsconfig).
• packages/typescript-config
• Shared TS configurations for libraries and Next.js.
README for additional insights
• Emphasizes FumaDB is built for library authors and unifies multiple database backends.
Elements
• Clear labels for:
• Monorepo root (workspace manager, CI/CD)
• FumaDB core modules (schema, query, CLI)
• Adapter implementations
• Docs site and example app as consumers
• External database engines
• From consumers → library API
• From library adapters → external databases
• From CLI → schema & migration modules → database
• CI/CD → build/test/publish workflows