korajs

Offline-first application framework. Local-first storage, reactive queries, automatic conflict resolution, and real-time sync -- with zero distributed systems code.

Install

pnpm add korajs

Quick Start

import { createApp, defineSchema, t } from 'korajs'

const app = createApp({
  schema: defineSchema({
    version: 1,
    collections: {
      todos: {
        fields: {
          title: t.string(),
          completed: t.boolean().default(false),
          createdAt: t.timestamp().auto(),
        },
      },
    },
  }),
})

const todo = await app.todos.insert({ title: 'Ship Kora v1' })
const active = await app.todos.where({ completed: false }).orderBy('createdAt').exec()
await app.todos.update(todo.id, { completed: true })
app.todos.where({ completed: false }).subscribe((todos) => console.log(todos))

Enable Sync

Add one line to sync across devices:

const app = createApp({
  schema,
  sync: { url: 'wss://my-server.com/kora' },
})

Conflicts are resolved automatically. No distributed systems code required.

React Integration

Install @korajs/react alongside this package (pnpm add @korajs/react):

import { KoraProvider, useQuery, useMutation } from '@korajs/react'

function App() {
  return (
    <KoraProvider app={app}>
      <TodoList />
    </KoraProvider>
  )
}

function TodoList() {
  const todos = useQuery(app.todos.where({ completed: false }))
  const addTodo = useMutation(app.todos.insert)
  return todos.map((todo) => <div key={todo.id}>{todo.title}</div>)
}

Packages

@korajs/core | @korajs/store | @korajs/merge | @korajs/sync | @korajs/server | @korajs/react | @korajs/devtools | @korajs/cli

License

MIT

See the full documentation for guides, API reference, and examples.