go-tui: Go SDK Quickstart

.github/CODEOWNERS

@@ -14,6 +14,7 @@
 /dotnet-maui/        @busec0 @phatblat
 /dotnet-tui/         @busec0 @phatblat
 /flutter_quickstart/ @cameron1024 @teodorciuraru
+/go-tui/             @kristopherjohnson
 /javascript-tui/     @konstantinbe @pvditto @teodorciuraru
 /javascript-web/     @konstantinbe @pvditto @teodorciuraru
 /react-native/       @teodorciuraru @kristopherjohnson

go-tui/README.md

@@ -0,0 +1,144 @@
+# Ditto Go Quickstart App 🚀
+
+This directory contains Ditto's quickstart app for the Go SDK.
+This app is a Terminal User Interface (TUI) that allows for creating
+a todo list that syncs between multiple peers.
+
+## Getting Started
+
+To get started, you'll first need to create an app in the [Ditto Portal][0]
+with the "Online Playground" authentication type. You'll need to find your
+AppID and Online Playground Token, Auth URL, and Websocket URL in order to use this quickstart.
+
+[0]: https://portal.ditto.live
+
+From the repo root, copy the `.env.sample` file to `.env`, and fill in the
+fields with your AppID, Online Playground Token, Auth URL, and Websocket URL:
+
+```
+cp ../../.env.sample ../../.env
+```
+
+The `.env` file should look like this (with your fields filled in):
+
+```bash
+#!/usr/bin/env bash
+
+# Copy this file from ".env.sample" to ".env", then fill in these values
+# A Ditto AppID, Online Playground Token, Auth URL, and Websocket URL can be obtained from https://portal.ditto.live
+export DITTO_APP_ID=""
+export DITTO_PLAYGROUND_TOKEN=""
+export DITTO_AUTH_URL=""
+export DITTO_WEBSOCKET_URL=""
+```
+
+## Building
+
+Build the FFI library (required for Ditto SDK):
+```bash
+(cd ../../ditto/sdks/go && make build) && go build -o go-tui main.go && ./go-tui  2>/dev/null
+```
+
+Build the application:
+```bash
+go build -o ditto-tasks-termui
+```
+
+## Running
+
+Run the quickstart app with the following command:
+
+```bash
+./ditto-tasks-termui 2>/dev/null
+```
+
+Or run directly with Go:
+```bash
+go run main.go 2>/dev/null
+```
+
+> NOTE: The `2>/dev/null` is a workaround to silence output on `stderr`, since
+> that would interfere with the TUI application. Without it, the screen will
+> quickly become garbled due to Ditto's internal logging.
+
+## Controls
+
+- **j/↓**: Move down
+- **k/↑**: Move up
+- **Enter/Space**: Toggle task completion
+- **c**: Create new task
+- **e**: Edit selected task
+- **d**: Delete selected task
+- **q**: Quit application
+- **Esc**: Cancel input mode
+
+## Features
+
+- ✅ Create, edit, and delete tasks
+- ✅ Mark tasks as complete/incomplete  
+- ✅ Real-time synchronization across devices
+- ✅ Terminal-based interface using termui
+- ✅ Cross-platform compatibility with other Ditto quickstart apps
+
+## Data Model
+
+Tasks are stored in a `tasks` collection with the following structure:
+```json
+{
+  "_id": "unique-task-id",
+  "title": "Task description",
+  "done": false,
+  "deleted": false
+}
+```
+
+This matches the data model used by other quickstart apps (Rust, C++, etc.) for cross-platform sync compatibility.
+
+## UI Features
+
+The TUI displays tasks in a table format with:
+- Selection indicator (❯❯) for the currently selected task
+- Checkboxes showing task status (✅ for done, ☐ for not done)
+- Modal overlay for creating and editing tasks
+- Keyboard shortcut hints in the status bar
+
+## Troubleshooting
+
+### Library not found
+If you get a library loading error, ensure the FFI library is built and available:
+```bash
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:../../ditto/sdks/go/build
+```
+
+On macOS, you may need to use `DYLD_LIBRARY_PATH` instead:
+```bash
+export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:../../ditto/sdks/go/build
+```
+
+### Environment variables not found
+The app looks for `.env` file in parent directories. Ensure it exists in the repository root with all required variables set.
+
+### Garbled screen output
+Always run the application with `2>/dev/null` to suppress stderr output that can interfere with the TUI display:
+```bash
+./ditto-tasks-termui 2>/dev/null
+```
+
+## Development
+
+The application uses:
+- [termui v3](https://github.com/gizak/termui) for the TUI framework (similar to Rust's ratatui)
+- [Ditto Go SDK](https://docs.ditto.live) for real-time sync
+- Channels for async communication between Ditto observers and the UI
+
+## Architecture
+
+The app follows an event-driven architecture similar to the Rust TUI implementation:
+- Direct event loop handling keyboard input
+- Table widget for displaying tasks
+- Manual text input handling for create/edit modes
+- Async updates from Ditto observers via Go channels
+
+## License
+
+MIT

go-tui/go.mod

@@ -0,0 +1,23 @@
+module github.com/getditto/quickstart/go-tui
+
+go 1.23.0
+
+toolchain go1.24.5
+
+require (
+	github.com/getditto/ditto-go-sdk v0.0.0
+	github.com/gizak/termui/v3 v3.1.0
+	github.com/google/uuid v1.6.0
+	github.com/joho/godotenv v1.5.1
+)
+
+replace github.com/getditto/ditto-go-sdk => /Users/kristopherjohnson/work/go-sdk/sdks/go
+
+require (
+	github.com/fxamacker/cbor/v2 v2.5.0 // indirect
+	github.com/mattn/go-runewidth v0.0.16 // indirect
+	github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7 // indirect
+	github.com/nsf/termbox-go v0.0.0-20190121233118-02980233997d // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
+	github.com/x448/float16 v0.8.4 // indirect
+)

go-tui/go.sum

@@ -0,0 +1,28 @@
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/fxamacker/cbor/v2 v2.5.0 h1:oHsG0V/Q6E/wqTS2O1Cozzsy69nqCiguo5Q1a1ADivE=
+github.com/fxamacker/cbor/v2 v2.5.0/go.mod h1:TA1xS00nchWmaBnEIxPSE5oHLuJBAVvqrtAnWBwBCVo=
+github.com/gizak/termui/v3 v3.1.0 h1:ZZmVDgwHl7gR7elfKf1xc4IudXZ5qqfDh4wExk4Iajc=
+github.com/gizak/termui/v3 v3.1.0/go.mod h1:bXQEBkJpzxUAKf0+xq9MSWAvWZlE7c+aidmyFlkYTrY=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
+github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
+github.com/mattn/go-runewidth v0.0.2/go.mod h1:LwmH8dsx7+W8Uxz3IHJYH5QSwggIsqBzpuz5H//U1FU=
+github.com/mattn/go-runewidth v0.0.16 h1:E5ScNMtiwvlvB5paMFdw9p4kSQzbXFikJ5SQO6TULQc=
+github.com/mattn/go-runewidth v0.0.16/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7 h1:DpOJ2HYzCv8LZP15IdmG+YdwD2luVPHITV96TkirNBM=
+github.com/mitchellh/go-wordwrap v0.0.0-20150314170334-ad45545899c7/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo=
+github.com/nsf/termbox-go v0.0.0-20190121233118-02980233997d h1:x3S6kxmy49zXVVyhcnrFqxvNVCBPb2KZ9hV2RBdS840=
+github.com/nsf/termbox-go v0.0.0-20190121233118-02980233997d/go.mod h1:IuKpRQcYE1Tfu+oAQqaLisqDeXgjyyltCfsaoYN18NQ=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
+github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
+github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
+github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
+github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/x448/float16 v0.8.4 h1:qLwI1I70+NjRFUR3zs1JPUCgaCXSh3SW62uAKT1mSBM=
+github.com/x448/float16 v0.8.4/go.mod h1:14CWIYCyZA/cWjXOioeEpHeN/83MdbZDRQHoFcYsOfg=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=