Tether documentation
Build a reactive backend in Go and keep your clients in sync.
Tether is a reactive backend framework for Go. You write queries and mutations as Go functions. Tether tracks the data each query reads and pushes fresh results to connected clients over WebSockets whenever that data changes.
The examples use a Go server with a React client. Client examples also have a TypeScript tab for apps that use @tetherdb/client directly.
Start building
- Quick start: build a live message board with SQLite and React.
- What is Tether?: how Tether works and where it fits.
- Queries and mutations: read live data and change it.
- Reactivity: control when queries re-run.
Build an application
Add authentication and guards, group related writes with transactions, upload files, and run scheduled work.
The database guide covers models and migrations. The client reference covers hooks, subscriptions, errors, and reconnects. Use profiling to find slow server work, then follow deployment to go live.
What these docs cover
These docs describe version 1 of the Tether Go engine and the @tetherdb/react and @tetherdb/client 1.0 packages. Go examples use GORM with SQLite or PostgreSQL. TypeScript types in the examples describe your app's JSON responses; Tether doesn't generate them from your Go models.
Last updated on