Sandbox environment for starting Ceramic ecosystem locally. Components included:

• ipfs - IPFS instance with dag-jose codec enabled
• ganache - local Ethereum blockchain
• cas - Typescript Ceramic Anchor Service implementation
• ceramic. Typescript Ceramic implementation.

In order to use the Clayground you need to install:

• Docker
• docker-compose
• Node.js - v14.9.0
• TypeScript - v3.8.3.

The default Clayground configuration is stored in .env file.

Starting all the components locally in a synchronous manner:

docker-compose up

For more docker-compose options and start configuration visit the official documentation.

In order to test Clayground sandbox you need to build js-ceramic component:

./bin/build-ceramic.sh

When build has been completed, use ceramic.sh for executing commands.

For example, creating a tile:

./bin/ceramic.sh create tile --content '{"hello": "ceramic"}'

Of course, Ceramic CLI can always be installed from npm.

Clayground stores component data in ./data directory.

There is a utility script ./bin/rmstore.sh which cleans up components store.

For example:

./bin/rmstore.sh cas

There is a utility script ./bin/docker-destroy-all.sh which removes ALL docker containers and images.

For example:

./bin/docker-destroy-all.sh

@simonovic86

Apache-2.0 OR MIT

Built with from 3Box team.