LakeQL
Introduction
  • Overview
  • Why LakeQL
  • Key Concepts
Getting Started
  • Prerequisites
  • Quickstart
  • Environment
  • First Run
Architecture
  • System Overview
  • Data Flow
  • Request Lifecycle
Configuration
  • Config File
  • Runtime Lifecycle
  • Environment Variables
create-app
  • Usage
  • Template Structure
  • Post-Creation
Guides
  • Custom Resolvers
  • Extending the Schema
  • Mutations
  • Set Up a Trino Mutation
  • Deploying
Endpoints
  • Definition Format
  • Field Types
  • Nested Fields
  • Mutations
  • Glossary
Contributing
  • Local Development
  • Contribution Guide
  • Architecture
GitHub
LakeQL
  1. LakeQL
  3. create-app
  5. Template Structure

On this page

  1. How the Pieces Connect

Template Structure

What create-app generates.

create-app generates a complete, runnable project. The exact files depend on the adapters and authentication strategy you choose, but the shape stays consistent:

.env.exampleCopy to .env and fill in
lakeql.config.tsAdapters and data sources
package.jsonScripts and dependencies

How the Pieces Connect #

  • lakeql.config.ts declares the adapters and data sources. See config file .
  • src/index.ts calls createLakeQLApp , which loads the config, composes the runtime, and starts the API server. See server setup .
  • src/auth.ts / src/permissions.ts wire authentication and permissions .
  • src/schemas/ is where pull writes generated endpoint files.

The generated project uses workspace:* dependency versions only in local dev mode (--local). A normal run pins published versions.

Previous page

Usage

Next page

Post-Creation