# agent-js

**Repository Path**: chengran25/agent-js

## Basic Information

- **Project Name**: agent-js
- **Description**: No description available
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: aw/build/add-idp-dev-server
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-12-07
- **Last Updated**: 2021-12-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# agent-js

Use an Agent to interact with the Internet Computer from your JavaScript program.

This source code repository contains multiple npm packages, each under `./packages/`.

## Development

### Getting Started

1. Clone the git repository.
2. Run `npm install`

After that, you probably want to dive into a specific package in [./packages](./packages).

### GitHub Actions

GitHub Actions for this repo are configured in [./.github/workflows](./.github/workflows).

* [nodejs-ci.yml](./.github/workflows/nodejs-ci.yml) - For every git push, do a build, test of all packages.
* [commitlint.yml](./.github/workflows/commitlint.yml) - Run [commitlint](https://commitlint.js.org/#/) on every git commit message.

### Master Branch Conventions and Mergify

All 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.

Mergify 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).

### bin/* scripts

The following scripts can be found in [./bin](./bin):

Monorepo-related scripts run in this order, but are usually invoked by `npm install`:

* npm-postinstall - Run with `npm run postinstall` in this monorepo package.
  * It copies devtools dependencies from ./packages/agent-js-devtools/node_modules -> ./node_modules
* build - Build (`npm run build`) each subpackage in ./packages/
* test - Run `npm test` in each subpackage