JustScale

Installation

Get JustScale installed in your project

Requirements

  • Node.js 18 or later
  • TypeScript 5.0 or later
  • A package manager (npm, yarn, pnpm)

Install Core Package

Bash
pnpm add @justscale/core

Install Transport

Choose a transport for your application:

HTTP (REST APIs)
Bash
pnpm add @justscale/http
CLI (Command-line tools)
Bash
pnpm add @justscale/cli

TypeScript Configuration

JustScale requires strict TypeScript settings for full type safety. Ensure your tsconfig.json includes:

JSON
{
  "compilerOptions": {
    "strict": true,
    "strictNullChecks": true,
    "noImplicitAny": true,
    "target": "ES2022",
    "module": "NodeNext",
    "moduleResolution": "NodeNext"
  }
}

Optional Packages

Install additional packages based on your needs:

Bash
# Models and Repository patterns
pnpm add @justscale/models

# Testing utilities
pnpm add --save-dev @justscale/testing

# Authentication feature
pnpm add @justscale/auth

# Cluster support (recommended for production)
pnpm add @justscale/cluster

Next Steps