Getting started with Telepat

Basic concepts

When developing with Telepat, you will work with data objects, where you can store arbitrary data. Each object has one of a series of types you must predefine, and belongs to a certain collection of objects.

As opposed to traditional APIs that serve still snapshots of application data to clients, you use the Telepat API to create and manage subscriptions. Subscribtions work similarly to classic get requests, in that they respond by sending the client the initial state of the queried data. But subscribing to a set of objects also means that the client will get notified (via additional channels like websockets and push notifications) when any value within those objects is changed, and changes will be immediately merged into client state.

Before starting to design your Telepat app, get up to date with the data fundamentals ».

Deploying Telepat

The easiest way to connect your app to Telepat in under 5 minutes is by setting up a Cloud instance. Go to the Telepat homepage to learn more, and get started for free!

Telepat is open source software, so you can install it on your own hardware. You can boot up dependencies and Telepat services individually, or use the available Docker Compose files. Read all about it in the installation guide ».

Developing with Telepat

  • Use the Telepat API to register with the backend, authenticate users and create subscriptions. The Telepat API is complemented by push transports, like websockets or mobile push notifications. Read more in the API guide ».
  • You can use on of the available Telepat SDKs:

App tutorial

Learn how to develop a full-fledged chat application, with Facebook login, one-to-one messaging, delivery status and unread notifications, in 600 lines of code. Read the tutorial ».