{"id":26326188,"url":"https://github.com/open-web3-stack/parachain-launch","last_synced_at":"2025-04-13T07:51:01.748Z","repository":{"id":39563048,"uuid":"381183909","full_name":"open-web3-stack/parachain-launch","owner":"open-web3-stack","description":"Tool to generate docker-compose.yml to launch a full relaychain - parachain testnet.","archived":false,"fork":false,"pushed_at":"2025-04-01T00:49:41.000Z","size":2832,"stargazers_count":75,"open_issues_count":13,"forks_count":35,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-05T22:03:18.563Z","etag":null,"topics":["docker","polkadot-js","substrate"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-web3-stack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-06-28T23:18:50.000Z","updated_at":"2025-04-04T02:17:34.000Z","dependencies_parsed_at":"2023-12-01T02:25:34.156Z","dependency_job_id":"1843b947-d830-4c67-866d-1cb88cf5884f","html_url":"https://github.com/open-web3-stack/parachain-launch","commit_stats":{"total_commits":133,"total_committers":14,"mean_commits":9.5,"dds":"0.43609022556390975","last_synced_commit":"c646c8bad379b16298a0c04e28d13a377b864fd3"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-web3-stack%2Fparachain-launch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-web3-stack%2Fparachain-launch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-web3-stack%2Fparachain-launch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-web3-stack%2Fparachain-launch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-web3-stack","download_url":"https://codeload.github.com/open-web3-stack/parachain-launch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681494,"owners_count":21144700,"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":["docker","polkadot-js","substrate"],"created_at":"2025-03-15T19:35:46.001Z","updated_at":"2025-04-13T07:51:01.725Z","avatar_url":"https://github.com/open-web3-stack.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# parachain-launch\n\n- [Introduction](#introduction)\n- [Options](#options)\n- [Global Usage](#global-usage)\n- [Local Usage](#local-usage)\n- [Start relaychain and parachain](#start-relaychain-and-parachain)\n- [Additional Docker Commands](#additional-docker-commands)\n- [Resetting all data](#resetting-all-data)\n\n# Introduction\n\nparachain-launch is a script that generates a docker compose file allowing you to launch a testnet of multiple blockchain nodes.\n\n# Options\n\nThe following options are supported by the generate script.\n\n| Option        | Description                |Required            | Default      |\n| ------------- |----------------------------|:------------------:|--------------|\n| --config      | Path to config file.       | No                 | ./config.yml |\n| --output      | Path to output dir.        | No                 | ./output     |\n| --yes         | Overwrite generated files? | No                 | false        |\n\n# Global Usage\n\n1. Install the package globally:\n\n```sh\nyarn global add @open-web3/parachain-launch\n```\n\n2. Download the [example config](https://github.com/open-web3-stack/parachain-launch/blob/master/config.yml) file and edit as necessary.\n\n3. Run the generate script:\n\n```sh\nparachain-launch generate --config=/path/to/config.yml [--yes] [--output=/path/to/output]\n```\n\nThis will generate the docker files a folder called `output` in your current working directory or in the directory provided to the `--output` option.\n\n# Local Usage\n\n1. Install the package locally:\n\n```sh\nyarn add @open-web3/parachain-launch\n```\n\n2. Download the [example config](https://github.com/open-web3-stack/parachain-launch/blob/master/config.yml) file and edit as necessary.\n\n3. Run the service from within the local directory:\n\n```sh\nnode_modules/.bin/parachain-launch generate --config=/path/to/config.yml [--yes] [--output=/path/to/output]\n```\n\nThis will generate the docker files a folder called `output` in your current working directory or in the directory provided to the `--output` option.\n\n# Start relaychain and parachain\n\nTo start the nodes, navigate to the output folder that you generated the scripts in and build the docker container:\n\n```sh\ncd ./output # OR custom output directory\n\ndocker-compose up -d --build\n```\n\nNOTE: If you regenerate the output directory then you will need to rebuild the docker images.\n\n# Additional Docker Commands\n\nList all of the containers:\n\n```sh\ndocker ps -a\n```\n\nTrack container logs:\n\n```sh\ndocker logs -f [container_id/container_name]\n```\n\nStop all of the containers:\n\n```sh\ndocker-compose stop\n```\n\nRemove all of the containers:\n\n```sh\ndocker-compose rm\n```\n\nRemove all of the containers and volumes (This will wipe any existing chain data):\n\n```sh\ndocker-compose down -v\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-web3-stack%2Fparachain-launch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-web3-stack%2Fparachain-launch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-web3-stack%2Fparachain-launch/lists"}