deco live — the edge-native CMS

Live is the edge-native CMS based on fresh. It lets your business users live edit any fresh site.

Want to create a Live Site? Use the deco start template repo to create a new site. Clone it and run deno task start. That’s it.

Adding live to an existing fresh site

Add the $live import to your import_map.json file:

{
  "imports": {
    "$live/": "https://deno.land/x/live@0.0.8/",
    "(...)": "(...)"
  }
}

Then replace your routes/index.tsx file with this:

import { createLiveHandler, LivePage } from "$live/live.tsx";
export const handler = createLiveHandler();
export default LivePage;

Add the fallback route at: routes/[...path].tsx with this:

import LivePage from "./index.tsx";
export * from "./index.tsx";
export default LivePage;

And finally, create the live.ts file with this:

import manifest from "./deco.gen.ts";
import { start } from "$live/server.ts";

await start(manifest, {
  site: "mysitename",
  domains: ["mysitename.com"],
});

Replacing site and domains for your own values. Haven’t created a site yet? Go to deco.cx and create one for free.

PROTIP: When you create a site on deco.cx, you automatically get a working repository at deco-pages/<your-site>. You can clone it, start coding your components and deploying right away, with zero setup.

Live scripts

Live ships some utilitary scripts which you can add to your project as needed.

HTML to Component script

You can use the component script to transform any HTML in your clipboard into a Preact component.

Add the component task to your deno.json file:

{
  "tasks": {
    "start": "(...)",
    "component": "deno eval 'import \"$live/scripts/component.ts\"'"
  },
  "importMap": "./import_map.json"
}

Then copy some HTML into your clipboard. For example:

<div>
  <span>Hello World</span>
  <img src="/test.jpg"> 
  <!-- note the unclosed img tag, which is invalid JSX -->
</div>

Then run the component task passing the ComponentName as first argument:

deno task component MyTestComponent

The new component will be generated in ./components/MyTestComponent.tsx and should look like this:

export default function MyTestComponent() {
  return (
    <div>
      <span>Hello World</span>
      <img src="/test.jpg" /> {/* note the closed img tag! */}
    </div>
  );
}

Aditionally, the import snippet will replace your clipboard content:

import MyTestComponent from "../components/MyTestComponent.tsx";

Copy Partytown files script

The partytown library needs the web and service workers’ static files to work. This script copies these required files. More info: https://partytown.builder.io/copy-library-files Add the copyPartytown task to your deno.json file:

{
  "tasks": {
    // ...
    "copyPartytown": "deno eval 'import \"$live/scripts/copyPartytownFiles.ts\"'"
  },
  "importMap": "./import_map.json"
}

Then run the copyPartytown task with the first argument destination folder to copy partytown files

deno task copyPartytown "./static/~partytown/"

Pass the --debug flag to also copy Partytown’s debug files.

deno task copyPartytown "./static/~partytown/" -- "--debug"

Local development

  • cd examples/counter
  • Create an .env file with:
SUPABASE_KEY=...
SUPABASE_ACCOUNT=...
DECO_SITE=...
  • deno task start

Now browse:

http://localhost:8080/ for a dynamic page http://localhost:8080/test for a static page