Skip to content
@Cerebellum-Realtime

Cerebellum

Overview

Cerebellum is a scalable, open-source, drop-in infrastructure for realtime applications.

In short: we help you ship WebSocket-based realtime applications faster and more reliably.

To learn more about Cerebellum's development in detail, read our case study here.

At a Glance

Cerebellum is made up of several tools. Take a look at their READMEs, linked below:

  • CLI: deploy Cerebellum's infrastructure in just a few clicks
  • Client SDK: interact with Cerebellum on the front end
  • CDK: provision the AWS infrastructure that makes up Cerebellum
  • Server: manage the back-end server that powers Cerebellum

To see some examples/code samples from applications built with Cerebellum, take a look at:

Getting Started

Prerequisites

To create a Cerebellum application, the following must be installed/configured:

  • Node.js
  • AWS (see Cerebellum CLI for details)
  • React (if using Cerebellum React hooks)

Once you have these dependencies installed, you can use the Cerebellum CLI tool to create a Cerebellum application. Learn more about the CLI tool here.

  • npm install -g @cerebellum/cli to install the Cerebellum CLI tool
  • cerebellum --help to view a few useful commands for creating Cerebellum applications

Your First Cerebellum Application

There are two options for creating Cerebellum applications:

  • cerebellum create to create a new directory and deploy Cerebellum's infrastructure to AWS
  • cerebellum init to deploy Cerebellum's infrastructure in the current directory

Either of these commands will spin up an infrastructure that is configured to meet the specific needs of realtime applications. Cerebellum provides a preconfigured WebSocket server out of the box. You can use the Cerebellum Client SDK to interact with our server, or you can bring your own WebSocket server and only use Cerebellum for its infrastructure.

Once the Cerebellum infrastructure deployment is complete, you can get started developing right away.

  • Create a React or vanilla JavaScript application to power your front end
  • npm install @cerebellum/sdk to install the Cerebellum Client SDK
  • npx cerebellum-start to run the Cerebellum Docker image and dependencies for local development

Now you can start developing with Cerebellum!

Spinning Down

If at any point you want to stop the local development environment:

  • npx cerebellum-stop

To delete the Cerebellum infrastructure:

  • cerebellum destroy

Meet the Founders

Cerebellum was built by a group of four software engineers with a passion for coding and realtime applications. Together, we cover three of the four major cities in Texas—Dallas, Houston, and Austin—as well as one Canadian based out of Toronto. Our Canadian team member has since become an expert in the use of "y'all" and the mecca of "gastinations," Buc-ee's. In return, he has educated the Texan members on the benefits of poutine, maple syrup, and Tim Hortons.

Pinned Loading

  1. clientSDK clientSDK Public

    TypeScript 3

  2. server server Public

    TypeScript 1

  3. cli cli Public

    TypeScript 2

  4. cdk cdk Public

    TypeScript 1

Repositories

Showing 8 of 8 repositories
  • cdk Public
    Cerebellum-Realtime/cdk’s past year of commit activity
    TypeScript 1 0 0 0 Updated Aug 28, 2024
  • Cerebellum-Realtime/Cerebellum-Realtime.github.io’s past year of commit activity
    TypeScript 0 0 0 0 Updated Aug 23, 2024
  • Cerebellum-Realtime/clientSDK’s past year of commit activity
    TypeScript 3 0 0 0 Updated Aug 22, 2024
  • server Public
    Cerebellum-Realtime/server’s past year of commit activity
    TypeScript 1 0 0 0 Updated Aug 22, 2024
  • .github Public
    Cerebellum-Realtime/.github’s past year of commit activity
    0 0 0 0 Updated Aug 19, 2024
  • Cerebellum-Realtime/collaborative_editor_demo’s past year of commit activity
    TypeScript 0 0 0 0 Updated Aug 19, 2024
  • Cerebellum-Realtime/messaging_application_demo’s past year of commit activity
    JavaScript 0 0 0 0 Updated Aug 19, 2024
  • cli Public
    Cerebellum-Realtime/cli’s past year of commit activity
    TypeScript 2 0 0 0 Updated Aug 15, 2024

Top languages

Loading…

Most used topics

Loading…