Project Setup | Effect Schema | Effective Software

Let’s create a project and install the required dependencies.

Creating a Project

Create a new directory and initialize a Node.js project:

1
mkdir effect-schema
2
cd effect-schema
3
npm init -y

Installing Dependencies

Run the following command to install the required packages:

1
npm install effect@4.0.0-beta.20
2
npm install -D typescript tsx @types/node

Configuring the Project

Add "type": "module" to your package.json to enable ES modules:

1
{
2
  "name": "effect-schema",
3
  "version": "1.0.0",
4
  "description": "",
5
  "main": "index.js",
6
  "scripts": {
7
    "test": "echo \"Error: no test specified\" && exit 1"
8
  },
9
  "keywords": [],
10
  "author": "",
11
  "license": "ISC",
12
  "type": "module",
13
  "dependencies": {
14
    "effect": "4.0.0-beta.20"
15
  },
16
  "devDependencies": {
17
    "@types/node": "^25.2.3",
18
    "tsx": "^4.21.0",
19
    "typescript": "^5.9.3"
20
  }
21
}

Create a tsconfig.json in the project root:

1
{
2
  "compilerOptions": {
3
    "target": "ES2022",
4
    "module": "nodenext",
5
    "moduleResolution": "nodenext",
6
    "strict": true,
7
    "skipLibCheck": true,
8
    "forceConsistentCasingInFileNames": true,
9
    "outDir": "./dist"
10
  },
11
  "include": ["*.ts"]
12
}

Running TypeScript Files

We use tsx to run TypeScript files directly without a separate compilation step. Every code snippet in this course is complete and runnable. To try any example, copy the code into a .ts file (e.g., schema.ts) and run it with:

1
npx tsx schema.ts

Note that tsx does not perform type checking. To catch type errors, run npx tsc --noEmit separately.

Creating a Project

Installing Dependencies

Configuring the Project

Running TypeScript Files

Stay in the loop