Skip to main content

Get started with Resonate

How to get started using Resonate?

Scaffold a new project

Follow these steps to get started with a new project using Resonate.

1. Install the CLI

You can install the CLI using brew or download a binary from the releases page

brew install resonatehq/tap/resonate

2. Use a template

Scaffold a new project using a template from the CLI.

You can list the available templates and their descriptions using the following command:

resonate projects list

The language is indicated in the name of the template.

Scaffold a project from one of the listed templates.

resonate projects create --template <template_name> --name <your_project_name>

3. Run the Resonate Server

Run the Resonate Server as a remote promise store and message source.

Depending on the template you choose and the features you want to use, you will want to run the Resonate Server.

resonate serve

4. Customize the template!

Customize the template to your use case. Use the feature development guides, tutorials, and example apps as reference.