Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Node.js — JavaScript Runtime
• pnpm - Package Manager

Installation

Switch to the required Node.js version:

nvm use

Install the project dependencies:

pnpm install

Git Hooks Setup (New Repository)

If you are setting up a new repository, initialize Husky:

pnpm exec husky init

Then edit the generated .husky/pre-commit file:

pnpm lint-staged

Environment Variables

Copy the file named .env.example and rename it .env.development in the root of your project and replace the placeholder values with yours.

cp .env.example .env.development

Running the Project

pnpm run start:dev

---

Scripts Reference

Script	Description
pnpm run start	Start the compiled output from dist/
pnpm run start:dev	Start watch mode via tsx (no build step needed)
pnpm run build	Compile TypeScript and resolve path aliases
pnpm run type:check	TypeScript type-checking without emitting files
pnpm run format	Format all files with Prettier
pnpm run lint:fix	Run ESLint with auto-fix