{"id":22409103,"url":"https://github.com/astroxnetwork/astrox-js","last_synced_at":"2025-07-31T20:31:07.480Z","repository":{"id":39615192,"uuid":"393281395","full_name":"AstroxNetwork/astrox-js","owner":"AstroxNetwork","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-06T04:13:50.000Z","size":2744,"stargazers_count":2,"open_issues_count":5,"forks_count":2,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-12-04T04:03:26.319Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AstroxNetwork.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-08-06T06:45:10.000Z","updated_at":"2022-04-03T21:01:00.000Z","dependencies_parsed_at":"2024-06-19T10:00:46.311Z","dependency_job_id":"84f63709-11da-4981-8430-22fdfbcd62ce","html_url":"https://github.com/AstroxNetwork/astrox-js","commit_stats":{"total_commits":103,"total_committers":3,"mean_commits":"34.333333333333336","dds":"0.058252427184465994","last_synced_commit":"24113873d06cc7533d4b7b7ffea5122690e74e1e"},"previous_names":[],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstroxNetwork%2Fastrox-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstroxNetwork%2Fastrox-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstroxNetwork%2Fastrox-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AstroxNetwork%2Fastrox-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AstroxNetwork","download_url":"https://codeload.github.com/AstroxNetwork/astrox-js/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228295616,"owners_count":17897596,"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-12-05T12:06:35.365Z","updated_at":"2024-12-05T12:06:36.160Z","avatar_url":"https://github.com/AstroxNetwork.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# astrox-js\nUse official agent-js as template. DRY\n\n\u003c!-- # agent-js\n\nUse an Agent to interact with the Internet Computer from your JavaScript program.\n\nThis source code repository contains multiple npm packages, each under `./packages/`.\n\n## Development\n\n### Getting Started\n\n1. Clone the git repository.\n2. Run `npm install`\n\nAfter that, you probably want to dive into a specific package in [./packages](./packages).\n\n#### Workspaces\n\nWe use `npm` to manage this repo and its packages. A few useful\ncommands to keep in mind;\n\n- To run the unit tests locally, you can use `npm run test`.\n- To run e2e tests, you can use `npm run e2e`. **WARNING:** You need to have a running\n  replica locally. In our CI runs, we use the `ic-ref` which is not (at this time) available\n  publicly. Normally you can use a replica distributed with dfx (ie. dfx start in a project),\n  but there is no guarantee that the `next` branch will work with the latest published dfx.\n  Once you have a replica running locally, you must pass the port to the e2e tests using the\n  `IC_REF_PORT` environment vairable. If that variable is not set, the tests will fail.\n\n### Publishing\n\nTo publish to NPM, create a branch and run the following commands;\n\n- `npm install`. Makes sure everything is installed and up to date locally;\n- `npm run build --workspaces`. Builds all the applications and packages.\n- `npm run test`. Just in case.\n- `lerna version VERSION_NUMBER`. The `VERSION_NUMBER` should be set to\n  the version to be published (e.g. `0.6.30`). The `DIST_TAG` argument can be ignored\n\nThis will change your code locally, so create a `chore: release VERSION_NUMBER` commit and\npush. Once the PR is created get someone to review it.\n\nThen, when you have merged the new versions, open https://github.com/dfinity/agent-js/releases/new, click the \"Draft a new release\" button, enter the new tag version, and click \"Publish release\".\n\n### Publishing Docs\n\nUntil we have an internal process and centrally owned canister, docs can be released manually for `@astrox/agent` and `@astrox/authentication`.\n\n- Start from a fresh clone (or `git clean -dfx .`)\n- `npm install`\n- `npm run make:docs/reference`\n- `dfx deploy`\n\nNote - you may need to ask to be added as a controller for the wallet that owns the docs until this job is moved to CI\n\n### GitHub Actions\n\nGitHub Actions for this repo are configured in [./.github/workflows](./.github/workflows).\n\n- [nodejs-ci.yml](./.github/workflows/nodejs-ci.yml) - For every git push, do a build, test of all packages.\n- [commitlint.yml](./.github/workflows/commitlint.yml) - Run [commitlint](https://commitlint.js.org/#/) on every git commit message.\n\n### Master Branch Conventions and Mergify\n\nAll commits in the master branch should come from squashed GitHub Pull Requests, and those commit messages should follow the [conventionalcommits.org](https://conventionalcommits.org) syntax.\n\nMergify can take care of enforcing all of this. Just add the `automerge-squash` label to each Pull Request that Mergify should merge. This policy is configured via [./.mergify.yml](./.mergify).\n\n### bin/\\* scripts\n\nThe following scripts can be found in [./bin](./bin):\n\nMonorepo-related scripts run in this order, but are usually invoked by `npm install`:\n\n- npm-postinstall - Run with `npm run postinstall` in this monorepo package.\n  - It copies devtools dependencies from ./packages/agent-js-devtools/node_modules -\u003e ./node_modules\n- build - Build (`npm run build`) each subpackage in ./packages/\n- test - Run `npm test` in each subpackage\n\n### Formatting\n\nTo save time on formatting, we use automated formatting for this repo using prettier. You can either use git pre-commit hooks or run the command `npm exec prettier:format` before submitting your PR to have your changes pass. We check formatting on CI. --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastroxnetwork%2Fastrox-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fastroxnetwork%2Fastrox-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fastroxnetwork%2Fastrox-js/lists"}