Metaframe: Useful widgets for common metaframe interactions

Fast creation and deployment of advanced metaframe websites.

Target audience: developers building metaframes or any static website where having the core tools of development, building and publishing are packaged and require a small number of commands.

It has everything you need to get a connectable metaframe website up and running and deployed.

Optional features

• justfile: set NPM_PUBLISH to anything except true to disable publishing source code in ./src/lib to npm

Setup/getting started

1. Install just
2. Type: just

That's it. Commands are self-documenting.

Features

• vite for fast building
• preact for efficient, fast loading sites
• typescript for type checking
• chakra-ui.com for the UI framework
• just for a single method to build/test/deploy/publish
• docker because I don't want to touch/rely your host system except where needed

Assumptions:

• just will be the command runner, not npm (directly) or make or any other underlying tech specific command runner. just is the main entry point to control all aspects of the software lifecycle.
  • Prefer contextual error messages with calls to action over documentation that is not as close as possible to the code or commands. Distance creates indirection and staleness and barriers to keep updated.
• You are building to publish at github pages with the url: https://<user_org>.github.io/<repo-name>/
  • github pages 👆 comes with limited options for some config:
    • we build browser assets in ./docs instead of ./dist (typical default) so that publishing to github pages is less configuration
• Operating this repository should be "easy" and enjoyable. It's a product of love and passion, I am hoping that you enjoy using at least just a little bit.