Skip to content

[FEAT] TDK CLI integration: run a refine app as a local TDK resource #7623

Open

Description

@kburym

Summary

Request for a small, optional way to use npm create refine-app together with TDK CLI in a local multi-service setup, or, if that is not wanted here, for guidance on where such a note should live.

What TDK is

TDK (Tilt Development Kit, @tdk-landscape/tdk-cli-core) is a local multi-service runner. Every service has a service.json, and tdk up <stack> starts that slice with Docker + Tilt, health-checked boot order and *.localhost routing through Traefik. It is not a deploy tool and not a production Compose replacement. Requirements: Docker, Tilt, Bun (for the services it generates).

Tool Owns
npm create refine-app Admin-app scaffold (UI framework, data provider, auth)
tdk project / tdk resource / tdk up The local landscape: ports, stacks, Docker, Tilt, proxy

Why this might fit

refine can scaffold a Vite React app, and TDK already has a react frontend provider plus a generated API client for sibling backends. The useful part for refine users is the other half: a local landscape with the API and database that the refine data provider talks to.

What I am asking for

  • A docs page or example, "Run refine with a local TDK backend", showing a refine Vite app pointed at a TDK-routed API (*.localhost). I will write it and send the PR if you say where examples live.
  • No change to create-refine-app is requested.

Example flow:

tdk project --yes
tdk resource orders-api --type backend --stack shop --yes
npm create refine-app@latest shop-admin        # Vite + React
tdk resource shop-admin --type bring-your-own --stack shop
tdk up shop
tdk networks     # lists the *.localhost URLs to use as the data provider base URL

Acceptance

  • The example runs from a clean checkout using only the commands shown.
  • refine gains no dependency on TDK.
  • Optional and additive. TDK is not a required toolchain and does not deploy anything.

Non-goals

  • Replacing your deployment guidance. TDK is local-only.
  • Making TDK a dependency of refine.

Related

Companion issue on the TDK side (the provider or recipe that this depends on): tdk-landscape/tdk-cli-core#245

Disclosure: I'm one of the TDK maintainers, and I drafted this issue with AI assistance. TDK is a young, small project (1.3.x), so I'm keeping the ask small and optional. If this isn't a fit, or isn't wanted in the issue tracker, please just say so and I'll close it.

Activity

  1. Devkhunger commented on Oct 7, 2026

    @Devkhunger

    Hi @kburym, I'd like to help with the Refine side of this integration.

    I checked the companion TDK issue and saw that the create-refine-app bring-your-own example has already landed in tdk-landscape/tdk-cli-core#281.

    Would you and the Refine maintainers be okay with me working on the Refine-side documentation/example for this issue?

    If so, should this live under the Refine documentation or as an example under examples/?

    I'd keep the change small and optional, with no TDK dependency added to Refine, and verify the documented flow from a clean setup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions