# Getting started
Paving the way to your first AssemblyScript module.
# Setting up a new project
Make sure that a recent version of Node.js (opens new window) and its package manager npm (that comes with Node.js) are installed, then switch to a new directory and initialize a new Node.js module as usual:
Install the AssemblyScript compiler. Let's assume that it is not required in production and make it a development dependency:
npm install --save-dev assemblyscript
Once installed, the compiler provides a handy scaffolding utility to quickly set up a new project, here in the current directory:
npx asinit .
asinit command automatically creates the recommended directory structure and configuration files:
Directory holding the AssemblyScript sources being compiled to WebAssembly.
TypeScript configuration inheriting recommended AssemblyScript settings.
Example entry file being compiled to WebAssembly to get you started.
Build artifact directory where compiled WebAssembly files are stored.
Git configuration that excludes compiled binaries from source control.
Configuration file defining both a 'debug' and a 'release' target.
Package info containing the necessary commands to compile to WebAssembly.
Starter test to check that the module is functioning.
Starter HTML file that loads the module in a browser.
asinit supports the following options:
Sets up a new AssemblyScript project or updates an existing one.
asinit directory [options]
asinit ./newProject -y
--help, -h Prints this help message.
--yes, -y Answers all questions with their default option
for non-interactive usage.
# Working with your module
The example in
assembly/index.ts can now be compiled to WebAssembly by invoking the build command:
npm run asbuild
Doing so will emit the compiled binaries, bindings and definition files to the
The generated test case in
tests/index.js can be executed with:
Once built, the directory contains all the bits to use the module like any other modern Node.js ESM module:
import * as myModule from "myModule";
index.html shows how the module can be used on the Web. A web server serving
the module directory, defaulting to display
index.html, can be started with:
Note that not all of the files may be required depending on the use case, and it is safe
to delete what's not needed. If anything goes wrong,
asinit can be executed again, which
would restore the deleted default files while keeping already edited ones.
# The journey ahead
So far, so good! Now it is time to start editing the project of course, which typically involves:
Editing and adding source files within the
assembly/directory and updating the tests in
Realizing that WebAssembly still has a ways to go 🙂
But that's it already for a quick start. Read on to learn more!