Project Setup

We will use a bare-bone node project as the starting point.

If you want to follow along from scratch, create an empty directory. Or, you can clone the repo and use packages/example-tutorial directory, which has all the code already there. (Code blocks on these tutorial pages actually pull code directly from those files)

Project Structure

The project should have package.json, tsconfig.json and a src directory that is currently empty:

- src/
- package.json
- tsconfig.json

Run the following to make sure you have typescript and @pistonite/workex installed.

You can use any package manager - I am using pnpm as an example

pnpm i -D typescript 
pnpm i @pistonite/workex

If you want to build and serve the example after the walk-through, also install serve, and make sure you have bun callable from the command line. The easiest way to install both is:

pnpm i -D serve
pnpm i -g bun

Your package.json should be similar to the following after installing those dependencies:

{
    "dependencies": {
        "@pistonite/workex": "workspace:*"
    },
    "devDependencies": {
        "serve": "^14.2.4",
        "typescript": "^5.7.2"
    }
}

Now, create tsconfig.json:

{
    "compilerOptions": {
        "noEmit": true,
        "lib": ["esnext", "dom"],
        "target": "esnext",
        "useDefineForClassFields": true,
        "moduleDetection": "force",
        "module": "esnext",
        "moduleResolution": "bundler",
        "allowImportingTsExtensions": true,
        "isolatedModules": true,
        "strict": true,
        "skipLibCheck": true
    },
    "include": [ "src" ]
}