Skip to content

Repository files navigation

pipelex-method-apps

Templates for an app that runs MTHDS methods through the Pipelex API, one directory per shape and language. A template ships no method: it ships what every method needs, and one command turns a copy of it into the app for the method you have.

Template What a copy becomes
webapp-js/ A Next.js 16 web app that renders each method's input form and result view from the method's own contract, and runs it through @pipelex/sdk

Looking for worked examples instead? pipelex-starter-js is the gallery the web app template was extracted from, with several demo methods presented as tabs.

Start a project from a template

A project is a copy of one template directory, and nothing else from this repository. One command writes the template into a new directory, commits it as it came, and runs the template's create gesture with your method; a second starts the app:

export PIPELEX_API_KEY=…                               # from app.pipelex.com
npm create @pipelex/method-app@latest my-app -- --method path/to/my_method.mthds
make -C my-app serve                                   # the URL, once the page answers; make stop stops it

make serve starts the dev server in the background and proves that the page answers; make dev runs it in the foreground instead. --method takes a .mthds file or a directory of them, a method id from your organization's catalog (mt_…), or a published package address. The initializer's README lists its options, what it does with git, and the verdict each run ends with. The template's own README and docs/create.md say what the create gesture does and how to override what it derives.

Working on the templates

Each template is self-contained: it has its own Makefile, its own CLAUDE.md and its own checks, and works from inside its directory exactly as it will in a project. The root carries what belongs to the family, and runs every template's gate at once:

Target Purpose
make install Install every template's dependencies, and wire the pre-commit hook
make check The family's own checks, then every template's make check
make test The tests of the root's scripts and of the initializer, then every template's tests
make all check, test, then every template's build
make workflows Render the root twin of every template's CI workflows — needed after editing one
make check-family Check the family's one version, the workflow twins, and the formatting of the root's own files
make use-local Install each template's Pipelex packages from the workspace's checkouts
make use-local-form Install the workspace's mthds-form checkout alone into every template that uses the form kernel
make use-published Restore the Pipelex packages each template's lock file pins
make use-published-form Restore the @pipelex/mthds-form version the lock file pins, in every template that uses the form kernel
make local-status Say, for every template, whether each Pipelex package comes from a sibling checkout or from its registry

make help lists them all. docs/family.md explains the layout: why the root twins each template's workflows, how the initializer carries the templates, how the family carries one version and publishes it, and what a new template needs to join.

License

This project is licensed under the MIT license. Runtime dependencies are distributed under their own licenses.

About

GitHub template: a Next.js app that runs your MTHDS method through the Pipelex API, with its input form and result view generated from the method's contracts.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages