MallokMallok

DocsStart here

From an empty folder to a live site.

The quick start below is the short version. The full documentation lives in the repository on GitHub, next to the code it describes; this page is the map.

01Quick start

Five steps, one of them a command.

You need Node.js 22 or newer with npm, and a Cloudflare account with access to Workers, D1 and R2. The steps target the published 0.1.0-rc.10 candidate.

  1. Generate and check a project locally

    This installs dependencies, builds the project and checks the deployment configuration. It creates no cloud resources.

    npx mallok create my-site --no-deploy
    cd my-site
  2. Sign in to Cloudflare and deploy

    Check that whoami shows the account you intend to use. Creation provisions a Worker, a D1 database and an R2 bucket in it. Add --domain site.example.com to bind a hostname you control from the first deployment.

    npx wrangler login
    npx wrangler whoami
    npx mallok create . --slug my-site

    Already signed in and happy to do it in one go? npx mallok create my-site generates, verifies and deploys in a single command.

  3. Finish setup in the browser

    Open the setup URL the CLI prints and enter the one-time setup key. The wizard creates the administrator, sets the site name and languages, and offers example content — placeholders to replace before you present the site as your business.

  4. Bind a custom domain

    Edge caching needs a custom domain; a workers.dev address is for preview only. For edits to appear promptly, also add a cache-purge token (Zone → Cache Purge → Purge) and the zone id as Worker secrets. Without them, visitors see the previous version until the cache expires.

  5. Publish

    In the admin at /_mallok/app, edit a starter product or create your own, then publish. No rebuild. From a terminal or CI, publish a folder of bundles with a scoped API token instead:

    npx mallok publish ./content

Before you rely on it: this is a release candidate. There is no “Deploy to Cloudflare” button yet, and real inquiry email delivery has not been accepted end to end. Read the release status

02The map

Where to read next.

Every link below opens the document on GitHub. English is the primary documentation language; a Chinese translation exists for getting started and release status.

03Elsewhere

See it, read it, install it.

Live demo

A read-only Atelier site. The sample company and content are fictional; the admin and inquiry collection are not enabled there.

demo.mallok.dev

GitHub

Source, issues, changelog and the documentation itself, under Apache-2.0.

fobstack/mallok

One command. Your account. Your content.

Mallok creates a Worker, a D1 database and an R2 bucket in your own Cloudflare account and deploys the site there. Nothing is hosted by Mallok, and there is no Mallok account to open.

npx mallok create my-site

Needs Node.js 22+ and wrangler login. Add --no-deploy to generate and check a project locally without creating cloud resources. Currently a 0.1 release candidate.