/azle

TypeScript CDK for the Internet Computer

Primary LanguageHTMLMIT LicenseMIT

Azle logo

Coverage Status Downloads Version License

Azle (Beta)

TypeScript CDK for the Internet Computer.

Disclaimer

Things to keep in mind:

  • Azle does not yet have many live, successful, continuously operating applications deployed to the IC
  • Azle does not yet have extensive automated property tests
  • Azle does not yet have multiple independent security reviews/audits
  • Azle heavily relies on Boa which is self-proclaimed to be experimental

Documentation

See The Azle Book.

Discussion

Feel free to open issues or join us in the Discord channel.

Quick Start

npx azle new hello_world
cd hello_world

npm install
npm run dfx_install
npm run replica_start
npm run canister_deploy_local

npm run canister_call_set_message
npm run canister_call_get_message

Roadmap

The following are the major blockers to 1.0:

  • Extensive automated property testing (~Q1 2023)
  • Performance improvements if necessary (~Q2 2023)
  • Boa production-ready, JS Engine swapout, or risks accepted (~Q2 2023)
  • Multiple independent security reviews/audits (~Q2 2023)

Contributing

All contributors must agree to and sign the Azle License Extension.

Please reach out before working on anything that is not in the good first issues or help wanted issues. Before beginning work on a contribution, please create or comment on the issue you want to work on and wait for clearance from Demergent Labs.

See Demergent Labs' Coding Guidelines for what to expect during code reviews.

License

Azle's copyright is governed by the LICENSE and LICENSE_EXTENSION.