This is a monorepo that contains all DiceDB related tools and applications that make it fun and easy to use in the real world - inspired by the word alloy.

This monorepo includes the following packages/apps:

• @dicedb/playground-web @ ./apps/playground-web: an interactive platform designed to let users experiment with DiceDB commands in a live environment
• @dicedb/ui @ ./packages/ui: common UI components for alloy apps packaged into a internal package

1. Install nvm
2. Install node and yarn

nvm install 20.0.0
nvm use 20.0.0
corepack enable

yarn install

Please refer to the README of the specific app that you want to develop and contribute to. You can find them under the apps directory.

To build all apps and packages, run the following command:

yarn build

To build a specific package/app, run the following command:

yarn build --filter @dicedb/playground-web

Alternatively, you can also run yarn build:playground to build playground.

To run tests for all apps and packages, run the following command:

yarn test
yarn test:watch  # Running test in watch mode

To format all apps and packages, run the following command:

yarn format

To lint all apps and packages, run the following command:

yarn lint

The monorepo is divided into 3 main directories:

• apps: contains all the applications i.e. deployable units
• packages: contains all the packages i.e. reusable code across the apps
• tooling: contains all the configurations and tooling used across the monorepo

The Code Contribution Guidelines are published at CONTRIBUTING.md; please read them before you start making any changes. This will ensure a consistent standard of coding practices and developer experience.

Contributors can join the Discord Server for quick collaboration.