Skip to main content

Local Setup

This page covers the shared local setup pattern used across the current Antrix repositories.

Clone repositories​

Clone each repository into sibling folders under one parent directory. Example:

mkdir INTT
cd INTT

Then clone each project into that folder using your team's preferred Git remote.

Shared install pattern​

Most backend repositories follow the same setup pattern in their README:

git submodule update --init --recursive
cd share-entity
git checkout development
cd ..
pnpm install

Repositories that currently document this pattern:

  • mvp1-authentication-service
  • mvp1-setting-service
  • mvp2-data-service
  • mvp3-caution-report-queue-service
  • mvp3-changedp-queue-service
  • mvp3-ctt-queue-service
  • mvp3-gsb-queue-service
  • mvp3-gsb-service
  • mvp3-kci-queue-service
  • mvp3-ngoss-service
  • mvp3-nocgrid-service
  • mvp3-nocpro-service
  • mvp3-ticket-service
  • mvp3-tmf-service
  • mvp6-tass-queue-service
  • mvp6-vital-queue-service
  • mvp6-vital-service

Repeat the process below for each backend service:

cd /path/to/INTT/<service-name>
git submodule update --init --recursive
cd share-entity
git checkout development
cd ..
pnpm install

For the portal:

cd /path/to/INTT/intt-portal
pnpm install

For the mobile app:

cd /path/to/INTT/intt-mobile
flutter pub get

Runtime details after install​

After dependencies are installed, use the Local Runtime Matrix for:

  • default ports
  • required config files
  • DB, Redis, and RabbitMQ requirements
  • which services must run for each module

Notes about share-entity​

Several backend services include a share-entity folder or submodule. That is a strong sign that common models, utilities, or DB-related logic are shared across services.

Things to confirm with the team:

  • whether share-entity is always pinned to development
  • whether local feature work ever requires a different branch
  • whether a mismatch between service code and share-entity branch can break builds

Suggested setup checklist​

  • clone all required repositories
  • initialize submodules
  • install pnpm dependencies in each repository
  • obtain environment variables or config files
  • confirm DB, Redis, and message broker availability
  • verify each repository can run its main start command
  • identify which queue services are actually needed for your module

Common setup risks​

  • submodule not initialized
  • wrong branch checked out in share-entity
  • missing environment variables
  • local infra services not running
  • frontend proxy or backend base URLs not aligned
  • Flutter SDK or device setup not ready for intt-mobile