{"id":17495436,"url":"https://github.com/joincolony/colonyjs","last_synced_at":"2025-05-16T13:06:44.432Z","repository":{"id":32459134,"uuid":"112282190","full_name":"JoinColony/colonyJS","owner":"JoinColony","description":"🎪 Colony TypeScript libraries","archived":false,"fork":false,"pushed_at":"2024-10-29T08:56:39.000Z","size":36911,"stargazers_count":92,"open_issues_count":7,"forks_count":24,"subscribers_count":13,"default_branch":"main","last_synced_at":"2024-10-29T09:58:52.336Z","etag":null,"topics":["api","blockchain","colony","dapp","ethereum","ethersjs","web3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JoinColony.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2017-11-28T03:43:42.000Z","updated_at":"2024-10-29T08:55:12.000Z","dependencies_parsed_at":"2023-11-07T11:28:24.634Z","dependency_job_id":"90d57fb5-bf3e-44ed-b0d8-5e23e4bafd07","html_url":"https://github.com/JoinColony/colonyJS","commit_stats":{"total_commits":2913,"total_committers":39,"mean_commits":74.6923076923077,"dds":0.7140405080672846,"last_synced_commit":"143f7828b538492639f6231f23878e14d3e7008e"},"previous_names":[],"tags_count":299,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoinColony%2FcolonyJS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoinColony%2FcolonyJS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoinColony%2FcolonyJS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JoinColony%2FcolonyJS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JoinColony","download_url":"https://codeload.github.com/JoinColony/colonyJS/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248564702,"owners_count":21125408,"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":["api","blockchain","colony","dapp","ethereum","ethersjs","web3"],"created_at":"2024-10-19T14:06:12.093Z","updated_at":"2025-04-12T11:48:36.399Z","avatar_url":"https://github.com/JoinColony.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"🎪 Colony TypeScript libraries\n\n[![Discord](https://img.shields.io/discord/562263648173555742)](https://discord.gg/feVZWwysqM)\n\n# The Colony TypeScript libraries\n\nWe are providing the following packages in this monorepo:\n\n* [`@colony/sdk`](packages/sdk) - The development kit to build on top of Colony\n* [`@colony/colony-js`](packages/colony-js) - The Colony TypeScript reference implementation\n* [`@colony/core`](packages/core) - Shared utilities, types and constants for all Colony TypeScript libraries\n* [`@colony/contractor`](packages/contractor) - A nifty tool that creates Colony Network TypeScript bindings\n* [`@colony/events`](packages/events) - All Colony event types in one! Parse and serialize Colony event metadata\n* [`@colony/tokens`](packages/tokens) - Pre-built Colony token contract bindings\n\n## Developing\n\nTo start development on any of the included libraries, make sure you have Node v16.x and [`pnpm`](https://pnpm.io) v8.x installed.\n\nRun `pnpm run bootstrap` first\n\nTo install all required dependencies run `pnpm run bootstrap` (this is important!) the first time, later you can just do `pnpm install --frozen-lockfile` in the root directory of the repository.\n\nYou can run `pnpm lint`, `pnpm typecheck`, `pnpm test` and `pnpm build` in the root directory (will build all packages) or in the individual package directories.\n\n**Please make sure to include a [changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) when submitting a PR.**\n\n## Creating a main release\n\ncolonyJS is using [changesets](https://github.com/changesets/changesets) to create releases. Here's the workflow:\n\n1) Create a PR and add a [changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) within the PR\n2) Have the PR reviewed and merged into `main`\n3) `changesets` will create a release PR which collects all changes that have been merged since the last release\n4) This PR can be merged at any point to then create a new main release\n\n## Creating a snapshot (development) release\n\n1) Push your desired changes to a new branch (**do not forget to add a changeset - see above**)\n2) Use the \"Release a snapshot\" action under \"Actions\"\n  ![image](https://github.com/JoinColony/colonyJS/assets/2174084/0961174c-fee0-417f-a0d8-8fc286e4fa2d)\n4) Pick your branch that you would like to release a snapshot from\n  ![image](https://github.com/JoinColony/colonyJS/assets/2174084/365ab525-3b36-472e-9f73-56557fc8812d)\n5) The snapshot release will be available in npm under `0.0.0-next-TIMESTAMP` or `@snapshot`\n\n## Contributing\n\nAll contributions are welcome. Please read the [Contributing Guidelines](CONTRIBUTING.md) and review our [Code of Conduct](CODE_OF_CONDUCT.md) before submitting a PR.\n\n## License\n\nGPL-3.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoincolony%2Fcolonyjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoincolony%2Fcolonyjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoincolony%2Fcolonyjs/lists"}