This document describes the system architecture for an open source version of Katikati.
A deployment includes a few basic components:
- Nook (the browser based UI for having conversations)
- A Google Cloud / Firebase project for hosting the data storage and inter-service communications infrastructure
- A communications client (such as RapidPro) for handling the communications to the end-client (sms, IM, etc.)
- A messaging adapter for connecting to the communications client (in this repository you can find one such adapter for RapidPro)
- A PubSub handler for connecting Nook and the messaging adapter.
These components can be controlled by command line tools run from a developer's Linux or Mac OS machine.
The setup we recommend for running an open Katikati project is to deploy Nook to Firebase's hosting infrastructure, and to run the messaging adapter and the PubSub handler in a Google Cloud Virtual Machine, but they can also be run locally, from a developer's machine.
Below you can find a diagram summarising the components and how they integrate with each other:
The setup guide will guide you through all you need to do to have a deployment of the open source version of Katikati.