README.md

Clayground

Sandbox environment for starting Ceramic ecosystem locally. Components included:

• Ceramic - Typescript implementation of Ceramic
• CAS - Typescript implementation of Ceramic Anchor Service
• IPFS - IPFS daemon with dag-jose codec enabled
• Ganache - Local Ethereum blockchain

Prerequisites

In order to use the Clayground you need to install:

• Docker
• docker-compose
• Node.js - v14
• TypeScript

Running

The default Clayground configuration is stored in .env file.

Starting all the components locally in a synchronous manner:

docker-compose up

Pass in other configuration files with the --env-file flag:

docker-compose --env-file .env.dev-unstable up

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

Performance testing

To start performance testing one has to run additional benchie service:

docker-compose -f docker-compose.yml -f docker-compose.benchie.yml up

It will immediately start performance testing suite with all the tests.

Execute commands

First get the container ID for js-ceramic:

docker ps

Then run Ceramic commands with docker exec. For example, creating a tile:

docker exec <container_id> packages/cli/bin/ceramic.js create tile --content '{"hello": "ceramic"}'

Component storage

Clayground stores component data in the current directory under ./data.

Deleting component storage

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

For example:

./bin/rmstore.sh cas

Docker utilities

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

For example:

./bin/docker-destroy-all.sh

Maintainers

@v-stickykeys

License

Apache-2.0 OR MIT

Team

Built with ❤️ by the 3Box Labs team.