Keep Entry Material Super-Simple

[laz-001]

Example from the readme:

import { BackendPostgres } from "@openworkflow/backend-postgres";
import { OpenWorkflow } from "openworkflow";

const postgresUrl = process.env.DATABASE_URL; // connection url to your db
const backend = await BackendPostgres.connect(postgresUrl);
const ow = new OpenWorkflow({ backend });

const sendWelcomeEmail = ow.defineWorkflow(
  { name: "send-welcome-email" },
  async ({ input, step }) => {
    const user = await step.run({ name: "fetch-user" }, async () => {
      return await db.users.findOne({ id: input.userId });
    });

Prefer

import { OpenWorkflow } from "openworkflow";
const ow = new OpenWorkflow(); // uses sqlite backend by default

const sendWelcomeEmail = ow.defineWorkflow(
  { name: "send-welcome-email" },
  async ({ input, step }) => {
    const user = await step.run({ name: "fetch-user" }, async () => {
      return await db.users.findOne({ id: input.userId });
    });

related: #19 (comment)

This should be kept somewhere as a basic rule, or keep this simply in mind.

Newcomers should not be scared away by complex code or complex documentation.

[jamescmartinez]

Newcomers should not be scared away by complex code or complex documentation.

I agree wholeheartedly. Lots to do here!

There are a few prerequisites to making this happen (in-progress Backend interface updates, then finalizing and merging @nathancahill's SQLite PR #19), but it's definitely coming along.

[mariusflorescu]

The amount of people that use SQLite even for trying out is so small IMHO to make it default.
To be honest, all people I know have either a postgres image running 24/7 or just use neon/or any other tool to test solutions.

[laz-001]

@mariusflorescu - A library needs to address a broad audience, incl. folks that we potentially cannot imagine (and not "people we know").

@jamescmartinez , one thing you need to decide here:

const ow = new OpenWorkflow(); // uses sqlite backend by default

//vs.

const ow = new OpenWorkflow('sqlite'); // uses embedded sqlite backend

[mariusflorescu]

A library needs to address a broad audience, incl. folks that we potentially cannot imagine (and not "people we know").

Believe me, I know that 😉, but then what you said here should apply to your assumption, that the good decision for the broad audience is to default to sqlite, which I think it's a bad decision. IMHO there should be no default. You should always choose your backend.

[laz-001]

I think you're overanalyzing. Things ended with this comment: #46 (comment), one decision is still open, see #46 (comment).

Over from my end.