Biff 2 (WIP)

See Biff 2.0 sneak peak.

This repo contains the code for Biff 2.0: libraries and a demo app (though not the starter app, which will be in a separate repo). I've completed a "rough draft" of everything, so the overall structure is more-or-less locked in. Next I'll take a manual pass over each library to simplify and test the code and to write a README. I'll publish each library as I go. After that I'll move everything from this temporary repo to the main repo and then update the website.

Try it out

cd demo
clj -M:run dev

It'll say it emailed you a sign-in link/code, but it'll actually just be printed to the console. The demo app still has some bugs FYI. And also... please excuse the exuberance with which my agent has denoted that the demo app is used by myself for manual testing.

The libs all use :local/root dependencies so you can't actually add them as a dependency on your own project (I think?) until I explicitly publish them.

Resources

TODO

Tutorial

TODO. Might rewrite the old tutorial or might come up with something new.

Guide

These will be "explanations" per the grand unified theory of documentation definition. Relatively short and meant to (1) give you an overview of what things Biff covers, (2) the conceptual approach Biff takes toward each of those things, (3) links to other relevant documentation (howtos, reference, and library READMEs).

TODO:

• Architecture
• Database
• HTTP handlers
• Frontend
• Background work
• Security
• Operations
• Code quality (tests/formatting/linting)

Howto

TODO:

• Use the REPL
• Add DB schema
• Add a page
• Add an API route
• Add a work pipeline
• Customize the signin flow
• Provision a server and deploy
• Setup a sandboxed coding agent environment (with incus and/or docker sandboxes)
• Swap out the DB
• Migrate from Biff v1

Reference

API docs

Essays

TODO

Community

TODO

Libraries

Everything is subject to breaking changes for now, but if you'd like to try any of the released libraries out in your own project, use a dependency like:

com.biffweb/<lib> {:mvn/version "2.0.0-rc2"}

Replacing <lib> with core, fx, etc. After all the libs are published, the com.biffweb/biff dependency will wrap all the individual libs (except for com.biffweb/tasks since that's dev-only).

Released:

• biff.core

Remaining (see libs/):

• biff.config
• biff.run
• biff.tasks
• biff.fx
• biff.graph
• biff.sqlite
• biff.background
• biff.ring
• biff.datastar
• biff.auth
• biff.admin
• demo app

And then I have a few more things to make that won't be/aren't yet in this repo:

• sqlite starter app (this will be like the demo app but more blank. e.g. see biff-starter-sqlite which is out of date now but is, you know, blank)
• biff.xtdb (this will be based on some older Biff v1 XTDB code)
• XTDB starter app

I'll probably also add some additional database adapter libraries. Ones I have in mind:

• XTDB v1 (to make migrating from Biff v1 easier)
• Postgres
• Datomic
• Xitdb
• Datalevin
• Rama

Dependency graph

flowchart TD
  lib_admin[admin]
  lib_authenticate[authenticate]
  lib_background[background]
  lib_config[config]
  lib_core[core]
  lib_datastar[datastar]
  lib_fx[fx]
  lib_graph[graph]
  lib_ring[ring]
  lib_run[run]
  lib_sqlite[sqlite]
  lib_tasks[tasks]

  lib_admin --> lib_core
  lib_authenticate --> lib_fx
  lib_background --> lib_core
  lib_background --> lib_fx
  lib_config --> lib_core
  lib_datastar --> lib_core
  lib_fx --> lib_core
  lib_graph --> lib_core
  lib_graph --> lib_fx
  lib_ring --> lib_core
  lib_ring --> lib_fx
  lib_sqlite --> lib_core
  lib_sqlite --> lib_fx
  lib_tasks --> lib_config
  lib_tasks --> lib_core
  lib_tasks --> lib_run