https://github.com/emschwartz/tigerbeetle-schema-wizard
https://github.com/emschwartz/tigerbeetle-schema-wizard
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/emschwartz/tigerbeetle-schema-wizard
- Owner: emschwartz
- Created: 2023-11-08T21:07:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-08T22:10:09.000Z (over 1 year ago)
- Last Synced: 2025-02-16T10:36:23.394Z (4 months ago)
- Language: TypeScript
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TigerBeetle Schema Wizard
When using TigerBeetle, you need to model your use case in terms of [ledgers](https://docs.tigerbeetle.com/reference/accounts#ledger), [codes](https://docs.tigerbeetle.com/reference/accounts#code), [accounts](https://docs.tigerbeetle.com/reference/accounts), and [transfers](https://docs.tigerbeetle.com/reference/transfers). That means developers need to first wrap their heads around double-entry bookkeeping in order to take advantage of the power of TigerBeetle.
This project aims to simplify the usage of TigerBeetle by allowing you to define the schema of your business logic in a simple TOML format. It then generates client code in any of the supported languages to make building systems on top of TigerBeetle easy and error-free.
## Contents
- [Schema](./schema.toml)
- [Generated TypeScript client code\*](./src/generated.ts)
- [Example usage script](./src/index.ts)
\* Note: the client code is not currently being generated 😋
## Trying it out
1. [Run TigerBeetle on your local machine](https://docs.tigerbeetle.com/quick-start/single-binary)
2. Clone this repo
3. `npm install`
4. Run `npm run dev` to create two accounts, fund them, and send a transfer between them