<aside> 👉 This guide helps you set up your dev environment—including selecting and creating a data model, indexing, and querying.

The guide builds on the ComposeDB Docs and API Reference.

</aside>

<aside> 🚧 Caution: This is the first Developer Preview, so you’re likely to encounter bugs. ComposeDB is currently deployed on Ceramic’s Clay testnet, not mainnet. Currently there is no data permanence. We do not recommend using ComposeDB in production at this stage.

</aside>

Background

ComposeDB on Ceramic is a decentralized, composable graph database. It provides different configurations (building blocks) that allow developers to quickly build applications on Ceramic—including the ability to discover, create, share and reuse data models using GraphQL.

ComposeDB consists of a set of TypeScript libraries and tools—you will need a basic understanding of JavaScript and JavaScript package management.

Set up your dev environment

First, you will need to set up your working environment—install and configure relevant packages and required developer tools.

Install JavaScript runtime and package management tools

ComposeDB runs on Ceramic, so you will need the following developer tools to be able to run the Ceramic Node in addition to ComposeDB:

You can check which versions you have installed using the following commands:

node -v
npm -v
pnpm -v

Next, install the required dependencies.

Install dependencies and Ceramic developer tools