@ohos-ports/azle 0.33.0-beta.0

package/.scripts/update_jest_configs.ts

@@ -0,0 +1,248 @@
+#!/usr/bin/env tsx
+
+import { existsSync } from 'fs';
+import * as fs from 'fs/promises';
+import * as path from 'path';
+import { fileURLToPath } from 'url';
+
+// Default Jest config in case no reference file is provided
+const defaultJestConfig = `/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    testTimeout: 100_000_000,
+    transform: {
+        '^.+\\.ts$': [
+            'ts-jest',
+            {
+                isolatedModules: true,
+                astTransformers: {
+                    before: [{ path: 'ts-jest-mock-import-meta' }]
+                }
+            }
+        ],
+        '^.+\\.js$': 'ts-jest'
+    },
+    transformIgnorePatterns: ['/node_modules/(?!(azle)/)'] // Make sure azle is transformed
+};
+`;
+
+/**
+ * Reads the reference jest.config.js file
+ * @param referenceFilePath - Path to the reference jest.config.js file
+ * @returns The content of the reference file or the default config if the file doesn't exist
+ */
+const getReferenceConfig = async (
+    referenceFilePath?: string
+): Promise<string> => {
+    if (referenceFilePath && existsSync(referenceFilePath)) {
+        try {
+            const content = await fs.readFile(referenceFilePath, 'utf8');
+            console.info(`Using reference config from: ${referenceFilePath}`);
+            return content;
+        } catch (error) {
+            console.error(
+                `Error reading reference file: ${error instanceof Error ? error.message : String(error)}`
+            );
+            console.info('Falling back to default config');
+        }
+    } else if (referenceFilePath) {
+        console.error(`Reference file not found: ${referenceFilePath}`);
+        console.info('Falling back to default config');
+    } else {
+        console.info('No reference file provided, using default config');
+    }
+
+    return defaultJestConfig;
+};
+
+/**
+ * Checks if the content of a jest.config.js file matches the expected config
+ * @param filePath - Path to the jest.config.js file
+ * @param referenceConfig - The reference configuration to compare against
+ * @returns true if the content matches, false otherwise
+ */
+const checkJestConfig = async (
+    filePath: string,
+    referenceConfig: string
+): Promise<boolean> => {
+    try {
+        const content = await fs.readFile(filePath, 'utf8');
+        // Normalize content by removing whitespace and comments to ensure accurate comparison
+        const normalizedContent = content
+            .replace(/\/\/.*$/gm, '') // Remove single-line comments
+            .replace(/\s+/g, ''); // Remove all whitespace
+
+        const normalizedExpectedContent = referenceConfig
+            .replace(/\/\/.*$/gm, '')
+            .replace(/\s+/g, '');
+
+        return normalizedContent === normalizedExpectedContent;
+    } catch (error) {
+        console.error(
+            `Error reading jest.config.js at ${filePath}: ${error instanceof Error ? error.message : String(error)}`
+        );
+        return false;
+    }
+};
+
+/**
+ * Recursively searches for jest.config.js files and checks or updates them
+ * @param directory - The directory to search in
+ * @param referenceConfig - The reference configuration to use
+ * @param checkOnly - If true, only check and report mismatched files without updating
+ * @returns Object containing lists of matched, mismatched, and processed files
+ */
+const processJestConfigs = async (
+    directory: string,
+    referenceConfig: string,
+    checkOnly: boolean
+): Promise<{ matched: string[]; mismatched: string[]; processed: number }> => {
+    const result = {
+        matched: [] as string[],
+        mismatched: [] as string[],
+        processed: 0
+    };
+
+    try {
+        // Check if this directory contains a jest.config.js file
+        const jestConfigPath = path.join(directory, 'jest.config.js');
+        const hasJestConfig = existsSync(jestConfigPath);
+
+        // If it has a jest.config.js file, process it
+        if (hasJestConfig) {
+            result.processed++;
+
+            if (checkOnly) {
+                // Just check if the content matches
+                const matches = await checkJestConfig(
+                    jestConfigPath,
+                    referenceConfig
+                );
+                if (matches) {
+                    result.matched.push(jestConfigPath);
+                } else {
+                    result.mismatched.push(jestConfigPath);
+                    console.info(
+                        `Mismatched jest.config.js found in: ${directory}`
+                    );
+                }
+            } else {
+                // Update the file
+                console.info(`Found jest.config.js in: ${directory}`);
+                try {
+                    await fs.writeFile(jestConfigPath, referenceConfig, 'utf8');
+                    console.info(
+                        `Successfully updated jest.config.js in ${directory}`
+                    );
+                    result.matched.push(jestConfigPath);
+                } catch (error) {
+                    console.error(
+                        `Error updating jest.config.js in ${directory}: ${error instanceof Error ? error.message : String(error)}`
+                    );
+                    result.mismatched.push(jestConfigPath);
+                }
+            }
+        }
+
+        // Read all entries in the current directory
+        const entries = await fs.readdir(directory);
+
+        // Process subdirectories
+        for (const entry of entries) {
+            // Skip node_modules and .git directories
+            if (entry === 'node_modules' || entry === '.git') {
+                continue;
+            }
+
+            const fullPath = path.join(directory, entry);
+            const stats = await fs.stat(fullPath);
+
+            if (stats.isDirectory()) {
+                // Recursively process this subdirectory
+                const subResult = await processJestConfigs(
+                    fullPath,
+                    referenceConfig,
+                    checkOnly
+                );
+
+                // Combine results
+                result.matched = result.matched.concat(subResult.matched);
+                result.mismatched = result.mismatched.concat(
+                    subResult.mismatched
+                );
+                result.processed += subResult.processed;
+            }
+        }
+    } catch (error) {
+        console.error(
+            `Error processing directory ${directory}: ${error instanceof Error ? error.message : String(error)}`
+        );
+    }
+
+    return result;
+};
+
+async function main(): Promise<void> {
+    // Parse command line arguments
+    const args = process.argv.slice(2);
+    const checkMode = args.includes('--check');
+
+    // Find the reference file argument (--reference=path/to/jest.config.js)
+    const referenceArg = args.find((arg) => arg.startsWith('--reference='));
+    const referenceFilePath = referenceArg
+        ? referenceArg.split('=')[1]
+        : undefined;
+
+    // Find the start directory argument (any argument not starting with --)
+    const startDirectory =
+        args.find((arg) => !arg.startsWith('--')) ||
+        path.join(path.dirname(fileURLToPath(import.meta.url)), '..');
+
+    // Get the reference configuration
+    const referenceConfig = await getReferenceConfig(referenceFilePath);
+
+    if (checkMode) {
+        console.info(`Checking jest.config.js files in: ${startDirectory}`);
+        const { matched, mismatched, processed } = await processJestConfigs(
+            startDirectory,
+            referenceConfig,
+            true
+        );
+
+        console.info('\n--- Jest Config Check Summary ---');
+        console.info(`Total jest.config.js files found: ${processed}`);
+        console.info(`Files matching reference config: ${matched.length}`);
+        console.info(
+            `Files NOT matching reference config: ${mismatched.length}`
+        );
+
+        if (mismatched.length > 0) {
+            console.info('\nMismatched files:');
+            mismatched.forEach((file) => console.info(`- ${file}`));
+
+            console.info('\nRun without --check to update these files.');
+        }
+    } else {
+        console.info(
+            `Starting to update jest.config.js files in: ${startDirectory}`
+        );
+        const { matched, mismatched, processed } = await processJestConfigs(
+            startDirectory,
+            referenceConfig,
+            false
+        );
+
+        console.info('\n--- Jest Config Update Summary ---');
+        console.info(`Total jest.config.js files found: ${processed}`);
+        console.info(`Files successfully updated: ${matched.length}`);
+        console.info(`Files with update errors: ${mismatched.length}`);
+
+        if (mismatched.length > 0) {
+            console.info('\nFiles with errors:');
+            mismatched.forEach((file) => console.info(`- ${file}`));
+        }
+    }
+}
+
+main();

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AZLE token holders (nlhft-2iaaa-aaaae-qaaua-cai)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSE_EXTENSION.md

@@ -0,0 +1,42 @@
+# Azle License Extension
+
+Last updated: March 14, 2022
+
+## AZLE Token
+
+The AZLE token currently exists at canister id nlhft-2iaaa-aaaae-qaaua-cai on the [Internet Computer](https://internetcomputer.org/) and its source code can be found [here](https://github.com/lastmjs/extendable-token-azle).
+
+## Contributor Agreement
+
+Contributors to Azle agree to the following:
+
+1. You have all of the necessary legal rights, including any required permission from your employer, to include your contributions in the Azle project
+2. You transfer all of your copyright ownership in your contributions to the AZLE token holders
+3. You may or may not receive an AZLE token allocation based on your contributions
+4. AZLE token allocations are subject to the discretion of the AZLE token holders
+5. Regulatory compliance may prevent an allocation of AZLE tokens to any contributor
+6. Demergent Labs currently owns the majority of AZLE tokens
+7. By receiving AZLE tokens you agree to the following:
+    1. AZLE tokens are not transferable
+    2. AZLE token holder decisions will be made through majority (more than half) voting where one AZLE token equals one vote
+    3. AZLE token holder votes control at least the following items:
+        1. AZLE token holders' copyrights
+        2. AZLE token allocations
+        3. Amendments to this agreement
+    4. AZLE token holders do not control [Demergent Labs' Azle repository](https://github.com/demergent-labs/azle)
+
+To show your acceptance of this agreement with an electronic signature, add yourself to the list of contributors below on a new branch with a signed and GitHub-verified git commit. Pull request that branch into the main branch of [Demergent Labs' Azle repository](https://github.com/demergent-labs/azle).
+
+Your electronic signature will be considered final once the commit is included in the main branch of [Demergent Labs' Azle repository](https://github.com/demergent-labs/azle).
+
+## Contributors
+
+| Legal Name       | GitHub Username | Country of Residence | Date              |
+| ---------------- | --------------- | -------------------- | ----------------- |
+| Jordan Last      | lastmjs         | United States        | March 14, 2022    |
+| Dan Steren       | dansteren       | United States        | March 14, 2022    |
+| Radu Cazacu      | Raduc4          | Moldova              | March 24, 2022    |
+| Tarek Mouawad    | tarek-eg        | Germany              | March 31, 2022    |
+| Quint Daenen     | di-wu           | Belgium              | May 21, 2022      |
+| Ryan Vandersmith | rvanasa         | United States        | September 3, 2022 |
+| Shreyansh Jain   | sudoshreyansh   | India                | May 3, 2024       |

package/NOTICE

@@ -0,0 +1,222 @@
+This NOTICE pertains to some code snippets shown in [README.md](/README.md), various `JSDocs`, and other documentation.
+
+Copyright 2021 DFINITY Stiftung
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this file except in compliance with the License. You may obtain a copy of the
+License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed
+under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.
+
+[README.md](/README.md) contains derivative works licensed as MIT: https://github.com/demergent-labs/azle/blob/main/LICENSE
+
+---
+
+Some code adapted or taken from https://github.com/dfinity/ic-quickjs-demo are licensed as follows:
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2023 DFINITY Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,78 @@
+<div align="center">
+    <a href="https://github.com/demergent-labs/azle" target="_blank" rel="noopener noreferrer">
+        <img height="150" src="https://raw.githubusercontent.com/demergent-labs/azle/main/logo/logo.svg" alt="Azle logo">
+    </a>
+</div>
+</br>
+<div align="center">
+    <a href="https://github.com/demergent-labs/azle/actions/workflows/test.yml?query=branch%3Amain">
+        <img src="https://github.com/demergent-labs/azle/actions/workflows/test.yml/badge.svg" alt="Coverage Status">
+    </a>
+    <a href="https://npmcharts.com/compare/azle?minimal=true"><img src="https://img.shields.io/npm/dm/azle.svg" alt="Downloads"></a>
+    <a href="https://www.npmjs.com/package/azle"><img src="https://img.shields.io/npm/v/azle.svg" alt="Version"></a>
+    <a href="https://github.com/demergent-labs/azle/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/azle.svg" alt="License"></a>
+</div>
+
+# Azle (Release Candidate)
+
+TypeScript and JavaScript CDK for the [Internet Computer](https://internetcomputer.org/).
+
+## Disclaimer
+
+Azle stable mode is continuously subjected to [intense scrutiny and testing](https://github.com/demergent-labs/azle/actions), however it has not yet undergone intense security review.
+
+## Stable Mode
+
+Azle runs in stable mode by default.
+
+This mode is intended for production use after Azle's imminent 1.0 release. Its focus is on API and runtime stability, security, performance, TypeScript and JavaScript language support, the ICP APIs, and Candid remote procedure calls (RPC). There is minimal support for the Node.js standard library, npm ecosystem, and HTTP server functionality.
+
+## Experimental Mode
+
+Azle runs in experimental mode through explicitly enabling a flag in `dfx.json` or certain CLI commands.
+
+This mode is intended for developers who are willing to accept the risk of using an alpha or beta project. Its focus is on quickly enabling new features and functionality without requiring the time and other resources necessary to advance them to the stable mode. The Node.js standard libary, npm ecosystem, and HTTP server functionality are also major areas of focus.
+
+> NOTE: Keep clearly in mind that the experimental mode fundamentally changes the Azle Wasm binary. It is not guaranteed to be secure or stable in API changes or runtime behavior. If you enable the experimental mode, even if you only use APIs from the stable mode, you are accepting a higher risk of bugs, errors, crashes, security exploits, breaking API changes, etc.
+
+## Get Started
+
+The quickest way to get started is through the [hello_world Candid RPC example](https://github.com/demergent-labs/azle/tree/main/examples/stable/demo/hello_world) or the [hello_world HTTP Server example](https://github.com/demergent-labs/azle/tree/main/examples/experimental/demo/hello_world_http_server).
+
+You can create the hello_world Candid RPC example locally like this:
+
+```bash
+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:
+
+```bash
+npx azle new hello_world --http-server --experimental
+cd hello_world
+
+# Now read the README.md
+```
+
+## Documentation
+
+See [The Azle Book](https://demergent-labs.github.io/azle/).
+
+## Discussion
+
+Feel free to open issues or join us in the [Discord channel](https://discord.gg/5Hb6rM2QUM).
+
+## Contributing
+
+All contributors must agree to and sign the [Azle License Extension](/LICENSE_EXTENSION.md).
+
+Please reach out before working on anything that is not in the [good first issues](https://github.com/demergent-labs/azle/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or [help wanted issues](https://github.com/demergent-labs/azle/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). 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](/contributing/coding-guidelines.md) for what to expect during code reviews.
+
+## License
+
+Azle's copyright is governed by the [LICENSE](/LICENSE) and [LICENSE_EXTENSION](/LICENSE_EXTENSION.md).