Skip to main content

Quik Framework

Quik Framework is a modular TypeScript backend framework shipped as a monorepo. Each package under packages/ is an independent module that can be used standalone or combined with the rest of the framework.

What you will find here​

  • Module overviews with quickstarts, recipes, configuration, and API reference.
  • A curated structure for exploring the framework by capability.
  • Framework conventions and operational notes.

Getting started​

  1. Read the Getting Started guide.
  2. Install dependencies: pnpm install
  3. Build all packages: pnpm app:build
  4. Run tests: pnpm test

Documentation flow​

  • Start with Getting Started for end-to-end setup.
  • Read the module overview under Modules.
  • Use each module's API section for its reference surface.
  • Keep module readmes up to date to ensure the top of each page stays accurate.