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
- Install nvm
- Install node and yarn
nvm install 20.0.0
nvm use 20.0.0
corepack enableyarn installNote
Please go through the README of each package/app to understand how to run and develop them. The READMEs are located in the respective package/app directories. The information below is a quick reference to get you started common for all packages/apps.
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 buildTo build a specific package/app, run the following command:
yarn build --filter @dicedb/playground-webAlternatively, you can also run
yarn build:playgroundto build playground.
To run tests for all apps and packages, run the following command:
yarn test
yarn test:watch # Running test in watch modeTo format all apps and packages, run the following command:
yarn formatTo lint all apps and packages, run the following command:
yarn lintThe monorepo is divided into 3 main directories:
apps: contains all the applications i.e. deployable unitspackages: contains all the packages i.e. reusable code across the appstooling: 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.