{"id":21019476,"url":"https://github.com/ceramicnetwork/clayground","last_synced_at":"2025-10-06T10:32:16.118Z","repository":{"id":42468718,"uuid":"308327248","full_name":"ceramicnetwork/clayground","owner":"ceramicnetwork","description":"Sandbox environment for starting Ceramic ecosystem locally","archived":false,"fork":false,"pushed_at":"2023-08-16T01:50:16.000Z","size":387,"stargazers_count":6,"open_issues_count":5,"forks_count":3,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-01-20T23:06:57.429Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ceramicnetwork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-29T12:50:39.000Z","updated_at":"2023-05-06T07:37:03.000Z","dependencies_parsed_at":"2025-01-21T03:00:35.267Z","dependency_job_id":null,"html_url":"https://github.com/ceramicnetwork/clayground","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicnetwork%2Fclayground","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicnetwork%2Fclayground/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicnetwork%2Fclayground/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ceramicnetwork%2Fclayground/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ceramicnetwork","download_url":"https://codeload.github.com/ceramicnetwork/clayground/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235519884,"owners_count":19003201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T10:32:26.751Z","updated_at":"2025-10-06T10:32:10.828Z","avatar_url":"https://github.com/ceramicnetwork.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Clayground\n\nSandbox environment for starting Ceramic ecosystem locally. Components included:\n\n* [Ceramic](https://github.com/ceramicnetwork/js-ceramic) - Typescript implementation of Ceramic\n* [CAS](https://github.com/ceramicnetwork/ceramic-anchor-service) - Typescript implementation of Ceramic Anchor Service\n* [IPFS](https://github.com/ceramicnetwork/js-ceramic/tree/develop/packages/ipfs-daemon) - IPFS daemon with [dag-jose](https://github.com/ceramicnetwork/js-dag-jose) codec enabled\n* [Ganache](https://www.trufflesuite.com/ganache) - Local Ethereum blockchain\n\n### Prerequisites\n\nIn order to use the Clayground you need to install:\n\n* [Docker](https://docs.docker.com/get-docker/)\n* [docker-compose](https://docs.docker.com/compose/install/)\n* [Node.js - v14](https://nodejs.org)\n* [TypeScript](https://www.typescriptlang.org)\n\n### Running\n\nThe default Clayground configuration is stored in `.env` file.\n\nStarting all the components locally in a synchronous manner:\n\n```shell script\ndocker-compose up\n```\n\nPass in other configuration files with the `--env-file` flag:\n\n```shell script\ndocker-compose --env-file .env.dev-unstable up\n```\n\nFor more `docker-compose` options and start configuration visit the [official documentation](https://docs.docker.com/compose/reference/overview/).\n\n**Performance testing**\n\nTo start performance testing one has to run additional `benchie` service:\n```shell\ndocker-compose -f docker-compose.yml -f docker-compose.benchie.yml up\n```\n\nIt will immediately start performance testing suite with all the tests.\n\n### Execute commands\n\nFirst get the container ID for js-ceramic:\n```shell script\ndocker ps\n```\n\nThen run Ceramic commands with `docker exec`. For example, creating a tile:\n```shell script\ndocker exec \u003ccontainer_id\u003e packages/cli/bin/ceramic.js create tile --content '{\"hello\": \"ceramic\"}'\n```\n\n### Component storage\n\nClayground stores component data in the current directory under `./data`.\n\n#### Deleting component storage\n\nThere is a utility script `./bin/rmstore.sh` which cleans up components store.\n\nFor example:\n```shell script\n./bin/rmstore.sh cas\n```\n\n### Docker utilities\n\nThere is a utility script `./bin/docker-destroy-all.sh` which removes **ALL** docker containers and images.\n\nFor example:\n```shell script\n./bin/docker-destroy-all.sh\n```\n\n## Maintainers\n[@v-stickykeys](https://github.com/v-stickykeys)\n\n## License\n\nApache-2.0 OR MIT\n\n## Team\n\nBuilt with ❤️ by the [3Box Labs](https://3boxlabs.com) team.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceramicnetwork%2Fclayground","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fceramicnetwork%2Fclayground","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fceramicnetwork%2Fclayground/lists"}