git » sdk

Borogove SDK

git clone https://borogove.dev/src/r/sdk

Borogove

Borogove is a high-level headless chat SDK for building chat apps or chat experiences into other apps, backed by any Snikket-compatible server.

Building Everything

make hx-build-dep
make

Running Tests

make test

or, for a more comprehensive and slower set of tests:

make ci

JavaScript / TypeScript

npm subdirectory will contain installable package for browser or nodejs after build, or simply:

npm i borogove

Typescript typings are generated which include documenation comments.

C

libborogove.so and cpp/borogove.h, the latter has documentation comments.

Alternately there is also libborogove.batteriesincluded.so which vendors some dependencies. Or libborogove.a which is a static library.

If you want to build on a system that does not have Haxe:

make cpp

The the cpp folder will contain C++ code and a Makefile with no haxe dependency.

Swift

libborogove.so and cpp/borogove.h are wrapped by cpp/Borogove.swift

See also the SwiftPM Package.

Documentation

https://borogove.dev/docs/


tree
.builds/
.github/
borogove/
build-misc/
cpp/
doc/
docs/
npm/
test/
.dockerignore 65
.git-blame-ignore-revs 41
.gitignore 302
.oxfmtrc.json 152
.oxlintrc.json 81
COPYING 11358
Docc2Mkdocs.hx 7391
HaxeCBridge.hx 90165
HaxeSwiftBridge.hx 37764
Makefile 8465
README.md 1162
browserjs.hxml 530
cpp.hxml 476
haxedoc.hxml 230
mkdocs.yml 790
nodejs.hxml 622
optional-sqlite-types.awk 523
optional-sqlite.awk 2300
test.hxml 284
testcpp.hxml 354
testjs.hxml 549
vitest.config.mts 1285
xlocale.patch 408

branches
main
omemo
compiled
strophe-fast

tags
0.0.1