Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 2.93 KB

README.md

File metadata and controls

68 lines (45 loc) · 2.93 KB
Raw

Azle (Beta)

TypeScript and JavaScript CDK for the Internet Computer.

Disclaimer

Please remember that Azle is in beta and thus it may have unknown security vulnerabilities due to the following:

  • Azle is built with various software packages that have not yet reached maturity
  • Azle does not yet have multiple independent security reviews/audits
  • Azle does not yet have many live, successful, continuously operating applications deployed to ICP

Get Started

The quickest way to get started is through the hello_world Candid RPC example or the hello_world HTTP Server example.

You can create the hello_world Candid RPC example locally like this:

npx azle new hello_world
cd hello_world

# Now read the README.md

You can create the hello_world HTTP Server example locally like this:

npx azle new hello_world --http-server --experimental
cd hello_world

# Now read the README.md

Documentation

See The Azle Book.

Discussion

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

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.