Skip to content
kibtabPublic

About

Spreadsheet as client, database as server.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

100 Commits

Folders and files

GitHub go.mod Go version GitHub License

Coverage

Kibtab

Spreadsheet as client, database as server.

Kibtab turns a spreadsheet into a client for your relational database.

Excel is the first client. Other spreadsheet software can come later.

Your team keeps the familiar grid. Kibtab keeps the transactions, the version checks, and the audit trail.

Kibtab rejects a write from an out-of-date sheet. Every cell change is recorded.

Status

Kibtab is pre-release. The first release is v0.1.0. No binary is published yet. Read the plan for the scope of each version. Or read the plan file in the repository.

The Name

Kibtab joins two words.

Kiban (基盤) means foundation in Japanese. It is the word for the base layer under a structure.

Tabularium is the Latin register of public tables. It was the Roman archive where the state kept its records.

A foundation plus a register. That is what this project is.

The name is pronounced /kɪb-tæb/.

Getting Started

Read the guide for your task.

Task Guide
Install a binary or build from source the install guide
Run the stack on a server the self-hosting guides
Read the layers and the port contract the architecture guide
Read the terms the licence guide

Architecture

The code follows the Hexagonal architecture. The core holds the domain logic. It has no database driver and no HTTP code. The core names no database engine and no spreadsheet client.

cmd/kibtab/                    The wiring and the CLI
internal/core/domain/          The models. They name no engine or client.
internal/core/ports/           The interfaces. The core owns them.
internal/core/services/        The use cases. They call the ports only.
internal/adapters/driven/      One package per database engine.
internal/adapters/driver/      One package per transport.
client/                        One folder per spreadsheet client.

A new database means one new package under adapters/driven/. A new spreadsheet means one new client folder. Neither changes a file under internal/core/.

Read the architecture guide for the full design.

Documentation

Document Purpose
Plan The release plan. It splits the work by version.
Documentation index The list of every document.
Agent context The working agreement for AI coding agents.
Conventions The code, the documentation, and the scope rules.
Technical names The approved technical names for Kibtab.
Testing The kinds of test and the coverage rules.
Releasing The version number, the gate, and the release steps.
Licence The terms for Kibtab and the skill.
Third party notices The licences of each dependency.
Changelog format The format for each release file.
Credits The people, the projects, and the sources.
Contributing The steps to send a change.
Code of Conduct The terms for taking part.
Security The private route for a vulnerability.

Documentation follows two styles at the same time. The first style is Simplified Technical English. The second style is British English. Read the conventions guide for both.

Contributing

Read the contributing guide before you write code. Read the agent context when you are an AI agent. Read the plan before you start a task. Each task in the plan is a markdown check box. Read the contributing guide for the full steps.

Every commit uses Conventional Commits. Read the contributing guide for the format and the scopes.

Acknowledgements

Built on the ideas in the credits. The documentation rules come from the vendored SimpleEnglish skill.

About

Spreadsheet as client, database as server.

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages