TDK CLI integration: run a Feathers app as a local TDK resource · Issue #3708 · feathersjs/feathers · GitHub
Skip to content

TDK CLI integration: run a Feathers app as a local TDK resource #3708

Open

Description

@kburym

Summary

Request for a small, optional way to use npm create feathers 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 feathers App scaffold (create-feathers)
tdk project / tdk resource / tdk up The local landscape: ports, stacks, Docker, Tilt, proxy

Why this might fit

A generated Feathers app is an HTTP/WebSocket service with its own dev script. TDK can run it as a bring-your-own resource next to other services and a Postgres, which is the usual local setup for a Feathers app with a database adapter.

What I am asking for

  • A short docs note on running a Feathers app in a TDK landscape. I will send the PR if you say where it belongs.
  • No code change requested.

Example flow:

# you provide the Dockerfile; TDK does not generate one for bring-your-own
npm create feathers@latest orders-api
tdk resource orders-api --type bring-your-own --stack shop --dockerfile ./Dockerfile
tdk up shop

Acceptance

  • The note covers PORT, binding inside a container, and a health route.
  • Feathers is unchanged.
  • 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 Feathers.

Related

Companion issue on the TDK side (the provider or recipe that this depends on): flisk-sh/flisk#250

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

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