subfork.js

Javascript client library used to connect to Subfork sites.

Usage:

<script src="https://cdn.jsdelivr.net/npm/subfork@latest/dist/subfork.min.js"></script>

To use the latest dev (unstable) release:

<script src="https://code.fork.io/subfork.min.js"></script>

Instantiate Subfork client:

const sf = new Subfork();

Subscribe to task events (requires user to be authenticated):

sf.task("test").on("done", (e) => {
    console.log("done:", e);
});

Create a test task with some data:

sf.task("test").create({ t: 2 }).then((resp) => {
    console.log("task created:", resp);
});

badge.js

Used for displaying Subfork attribution badge on sites.

Usage:

<script src="https://cdn.jsdelivr.net/npm/subfork@latest/dist/badge.min.js"></script>

Development

For testing updates to subfork.js, use the vite dev server:

Dependencies:

$ npm i socket.io-client
$ npm i -D vite typescript

Building the targets:

$ npm run build

Running vite dev server:

$ npm run dev