Skip to main content

Getting started

This guide will help you set up and run the LAA Express TypeScript Template locally.

Prerequisites

  • node stable version 24.10.0
  • Yarn 4.9.2 package manager (see installation instructions below)
  • TypeScript 5.8.3

Installing Yarn

This project uses Yarn 4.9.2 managed by corepack (built into Node.js 16.10+). To ensure all team members use the same version, follow these installation steps:

  1. Enable corepack (if not already enabled):
   corepack enable
  1. Install dependencies:
   yarn install
  1. Verify the installation:
   yarn --version
   # Should output: 4.9.2

To Note:

  • Corepack automatically uses the Yarn version specified in the packageManager field of package.json. No additional setup is required once corepack is enabled
  • Corepack is the preferred yarn way, to install the package manager, instead of npm install -g yarn in your ci/cd pipeline
  • yarn install --immutable ensures that the lockfile (yarn.lock) is not modified during the installation process

Start the application

Set local environment variables

Create your local config file .env from the template file:

cp .env.example .env

Align to the Node version specified for this project

If using Node Version Manager (nvm), use the following command to switch to the correct version:

nvm use
nvm install

Install dependencies and run application for development

yarn install
yarn build
yarn dev

Then, load http://localhost:3000/ in your browser to access the app.

Install dependencies and run application for production

yarn install
yarn build
yarn start

Node Version Manager

You may have to tell your local machine to use the latest version of node already installed on your device, before installing and running the application. Use the following command.

nvm install node

Running locally with docker

Prerequisites, Docker Desktop

  • To build the docker image
  docker build -t your-repo-name:latest .
  • To run the docker image
  docker run -d -p 8888:3000 your-repo-name:latest

(The application should be running at http://localhost:8888)

  • To stop the container

obtain the container id

  docker ps

stop the container

  docker stop {container_id}
This page was last reviewed on 13 October 2025. It needs to be reviewed again on 24 November 2025 .