Quick start

Install

npm install ekolite

Three entry points, everything else stays internal for now:

import { App } from 'ekolite'; // the server framework
import { ConnectionManager } from 'ekolite/client'; // the browser client stack
import type { ReadyMsg } from 'ekolite/shared'; // the wire protocol types

const app = App.createNull();
app.methods.define('greet', (name) => `hello ${String(name)}`);
await app.methods.call('greet', ['world']); // 'hello world'

App.createNull() assembles the whole graph in memory, so you can exercise methods, publications and files without a running MongoDB. Swap it for App.create({ mongoUri, fileDir, port }) to talk to the real thing.

What comes back is empty. App wires the infrastructure and stops, so app.publications and app.methods hold exactly what you put on them and nothing of EkoLite's own:

const app = App.create({ mongoUri, fileDir, port });

app.publications.define('tasks.mine', (p) => ({ collection: 'tasks', query: { owner: p.owner } }));
app.methods.define('addTask', (title) => createTask(title));

To run your app as a server without writing a boot file, point an ekolite.config.ts at your definitions and use the ekolite run command. See Running your app.

Where next

• Running your app. Boot your own app with the ekolite run command.

• Overview — what EkoLite is and how the pieces fit together.

• System design — how the framework is put together, and the wire protocol.

• API reference — the client ConnectionManager and SubscriptionHandle.