Typescript Script and Application Starter

A starter template which can be used as a quick and easy starter for getting a project up and running.

Usage

From your command line, run:

1 npm init @nhtio/ts-app-starter@latest

Provide the script with the answers and let it create the folder and initialise the dependencies for you

Customization

You can search and replace all instances of @example/script within the project, but the main files which should be customized are:

• ./package.json
• ./vite.config.mts
• ./src/services/cli.ts

These are the main files which handle the naming of the project. Additionally, you can customize the ./src/env.ts file which is used to provide a validated and sanitized version of the environmental variables.

Example Dockerfile

1ARG IMAGE_PREFIX=
2ARG NODE_IMAGE=node:22-alpine
3FROM ${IMAGE_PREFIX}${NODE_IMAGE} as base
4
5##################################################
6# Setup the Base Container
7##################################################
8ENV LC_ALL=C.UTF-8
9RUN apk --no-cache add dumb-init postgresql-dev
10RUN mkdir -p /home/node/app && chown node:node /home/node/app
11WORKDIR /home/node/app
12USER node
13
14##################################################
15# Setup Dependencies & Build
16##################################################
17FROM base AS build
18ENV NODE_ENV=development
19USER root
20RUN apk --no-cache add python3 g++ make
21COPY --chown=node:node ./package*.json ./
22COPY --chown=node:node ./npm* ./
23COPY --chown=node:node ./yarn* ./
24COPY --chown=node:node ./.yarn* ./
25RUN yarn install --frozen-lockfile --production=false
26COPY --chown=node:node . .
27RUN yarn build
28RUN yarn package
29USER node
30
31##################################################
32# Wrap for Production
33##################################################
34FROM base AS production
35ARG VERSION=master
36ENV NODE_ENV=production
37COPY --chown=node:node --from=build /home/node/app/dist ./package*.json ./
38COPY --chown=node:node --from=build /home/node/app/dist ./npm* ./
39COPY --chown=node:node --from=build /home/node/app/dist ./yarn* ./
40COPY --chown=node:node --from=build /home/node/app/dist ./.yarn* ./
41USER root
42RUN apk --no-cache add python3 g++ make
43USER node
44RUN yarn install --frozen-lockfile --production
45USER root
46RUN apk del python3 g++ make
47COPY --chown=node:node --from=build /home/node/app/dist .
48USER node
49CMD [ "dumb-init", "node", "index.mjs" ]