Skip to main content

Prerequisites

Before running the Antrix project locally, make sure your machine has the required baseline tools.

Core tools​

  • Git
  • Node.js
  • npm
  • pnpm

For mobile work:

  • Flutter SDK compatible with >=3.2.3 <4.0.0
  • Dart SDK bundled with that Flutter version
  • Android Studio and or Xcode depending on target device

Install pnpm globally if it is not already available:

npm install -g pnpm

Frontend tooling​

The intt-portal project is an Angular application. It uses Angular CLI through project scripts, so a global install is usually optional, but some teams still prefer it:

npm install -g @angular/cli

Mobile tooling​

intt-mobile is a Flutter application, not a Node.js app. It does not use package.json and should be set up with Flutter tooling:

flutter --version
flutter doctor
flutter pub get

Backend tooling​

The backend services are NestJS applications. They run through local project scripts after dependency installation, so no special global Nest CLI install is required for day-to-day use.

Likely supporting services​

Based on project dependencies, local development may also require:

  • MariaDB or a MySQL-compatible database, depending on the backend service
  • Redis
  • RabbitMQ for services using AMQP or microservice messaging

Important note:

  • DBeaver is a database client tool, not the database service itself
  • use DBeaver if the team prefers it for DB access and query inspection
  • you still need actual DB connectivity to the backing MariaDB or MySQL-compatible instance

Confirm with the team which of these are mandatory for your module before first run.

Access you should request early​

  • Git repository access for all Antrix repos
  • access to shared submodule repositories such as share-entity
  • database credentials or seed data guidance
  • SSO test credentials
  • environment variable samples or secrets management process
  • TM VPN access, because internal services, environments, and API endpoints may require VPN connectivity before they are reachable

Sanity checks​

Use these commands to verify the main tooling:

node -v
npm -v
pnpm -v
git --version
flutter --version

Project-specific note​

This documentation currently captures repository structure and common commands from the codebase. Environment-specific setup such as secrets, hostnames, ports, and local proxies should be expanded as the team documents them.