create-carlonicora-app 1.0.0

package/template/Dockerfile

@@ -0,0 +1,228 @@
+# =============================================================================
+# Unified Dockerfile for {{name}} Monorepo
+# =============================================================================
+# This Dockerfile builds all services (API, Worker, Web) from a single file,
+# eliminating duplicate builds of the shared package by reusing build stages.
+#
+# Build targets:
+#   - api-development:  API with hot-reload for development (uses local submodules)
+#   - api-production:   Optimized API production build (uses npm packages)
+#   - web-development:  Web with hot-reload for development (uses local submodules)
+#   - web-production:   Optimized Web production build (uses npm packages)
+#
+# Usage:
+#   docker build --target api-production -t api:prod .
+#   docker build --target web-production -t web:prod .
+#   docker build --target api-development -t api:dev .
+#   docker build --target web-development -t web:dev .
+#
+# Benefits:
+#   - Shared package (@{{name}}/shared) built ONCE and reused
+#   - Faster builds when building multiple services
+#   - Better layer caching across services
+#   - Consistent base dependencies
+#   - Production uses pinned npm versions (versions.production.json)
+#   - Development uses local submodules for live editing
+# =============================================================================
+
+# =============================================================================
+# BASE STAGE - Common foundation for all services
+# =============================================================================
+FROM node:22-alpine AS base
+
+# Install pnpm
+RUN corepack enable && corepack prepare pnpm@10.18.2 --activate
+
+# Install build dependencies for native modules (required for sharp + webp)
+RUN apk add --no-cache python3 py3-pip make g++ cairo-dev jpeg-dev pango-dev giflib-dev libwebp-dev \
+    tesseract-ocr tesseract-ocr-data-ita graphicsmagick ghostscript
+
+WORKDIR /app
+
+# =============================================================================
+# WORKSPACE DEPENDENCIES (DEVELOPMENT) - Uses local submodules
+# =============================================================================
+FROM base AS workspace-deps
+
+# Copy workspace manifests (minimal set for faster caching)
+COPY package.json pnpm-lock.yaml pnpm-workspace.yaml ./
+COPY tsconfig.base.json tsconfig.json ./
+COPY packages/shared ./packages/shared/
+COPY packages/nestjs-neo4jsonapi ./packages/nestjs-neo4jsonapi/
+COPY packages/nextjs-jsonapi ./packages/nextjs-jsonapi/
+COPY apps/api ./apps/api/
+COPY apps/web ./apps/web/
+
+# Install all dependencies once (including dev deps for build targets)
+RUN pnpm install --frozen-lockfile
+
+# =============================================================================
+# SHARED PACKAGE BUILD (DEVELOPMENT) - Built ONCE and reused by dev services
+# =============================================================================
+FROM workspace-deps AS shared-builder
+
+WORKDIR /app/packages/shared
+RUN pnpm build
+
+# Build nestjs-neo4jsonapi package
+WORKDIR /app/packages/nestjs-neo4jsonapi
+RUN pnpm build
+
+# Build nextjs-jsonapi package
+WORKDIR /app/packages/nextjs-jsonapi
+ENV NODE_OPTIONS="--max-old-space-size=4096"
+RUN pnpm build
+
+# Return to workspace root for subsequent stages
+WORKDIR /app
+
+# =============================================================================
+# API DEVELOPMENT TARGET
+# =============================================================================
+FROM shared-builder AS api-development
+
+# Expose port (set via build arg; defaults to 3400 for local compose)
+ARG API_PORT=3400
+EXPOSE ${API_PORT}
+
+# Development command (hot reload) - stay in /app to access tsconfig.json
+CMD ["pnpm", "--filter", "{{name}}-api", "run", "dev"]
+
+# =============================================================================
+# WEB DEVELOPMENT TARGET
+# =============================================================================
+FROM shared-builder AS web-development
+
+# Expose port (set via build arg; defaults to 3401 for local compose)
+ARG PORT=3401
+EXPOSE ${PORT}
+
+# Development command (hot reload with Turbopack) - stay in /app to access node_modules
+CMD ["pnpm", "--filter", "{{name}}-web", "run", "dev"]
+
+# =============================================================================
+# WORKSPACE DEPENDENCIES (PRODUCTION) - Uses npm packages, not submodules
+# =============================================================================
+FROM base AS workspace-deps-prod
+
+# Copy workspace manifests
+COPY package.json pnpm-lock.yaml pnpm-workspace.yaml ./
+COPY tsconfig.base.json tsconfig.json ./
+COPY versions.production.json ./
+COPY scripts/apply-production-versions.js ./scripts/
+
+# Copy only the shared package (still local)
+COPY packages/shared ./packages/shared/
+
+# Copy app source
+COPY apps/api ./apps/api/
+COPY apps/web ./apps/web/
+
+# Apply production versions (replaces workspace:* with npm versions)
+RUN node scripts/apply-production-versions.js
+
+# Remove submodule entries from pnpm-workspace.yaml for production
+RUN sed -i '/nestjs-neo4jsonapi/d; /nextjs-jsonapi/d' pnpm-workspace.yaml
+
+# Install dependencies (fetches libraries from npm)
+RUN pnpm install --no-frozen-lockfile
+
+# =============================================================================
+# SHARED PACKAGE BUILD (PRODUCTION) - Only builds shared, not submodule packages
+# =============================================================================
+FROM workspace-deps-prod AS shared-builder-prod
+
+WORKDIR /app/packages/shared
+RUN pnpm build
+
+WORKDIR /app
+
+# =============================================================================
+# API BUILDER (production) - Uses npm packages
+# =============================================================================
+FROM shared-builder-prod AS api-builder
+
+WORKDIR /app
+RUN pnpm --filter {{name}}-api build
+
+# =============================================================================
+# API PRODUCTION TARGET
+# =============================================================================
+FROM node:22-alpine AS api-production
+
+# Install runtime dependencies only (no build tools + OCR)
+RUN apk add --no-cache cairo jpeg pango giflib libwebp \
+    tesseract-ocr graphicsmagick ghostscript
+
+RUN corepack enable && corepack prepare pnpm@10.18.2 --activate
+
+WORKDIR /app
+ENV NODE_ENV=production
+
+# Copy built files from api-builder
+COPY --from=api-builder /app/package.json /app/pnpm-lock.yaml /app/pnpm-workspace.yaml ./
+COPY --from=api-builder /app/packages/shared ./packages/shared
+COPY --from=api-builder /app/apps/api ./apps/api
+
+# Install only production dependencies
+RUN pnpm install --no-frozen-lockfile --prod --ignore-scripts
+
+WORKDIR /app/apps/api
+
+# Expose port (set via build arg; defaults to 3400 for local compose)
+ARG API_PORT=3400
+EXPOSE ${API_PORT}
+
+# Production command (can be overridden for worker mode)
+CMD ["node", "dist/main", "--mode=api"]
+
+# =============================================================================
+# WEB BUILDER (production) - Uses npm packages
+# =============================================================================
+FROM shared-builder-prod AS web-builder
+
+WORKDIR /app
+
+# Accept build arguments for Next.js public env vars
+ARG NEXT_PUBLIC_API_URL
+ARG NEXT_PUBLIC_ADDRESS
+ARG NEXT_PUBLIC_VAPID_PUBLIC_KEY
+
+# Set them as environment variables for the build
+ENV NEXT_PUBLIC_API_URL=${NEXT_PUBLIC_API_URL}
+ENV NEXT_PUBLIC_ADDRESS=${NEXT_PUBLIC_ADDRESS}
+ENV NEXT_PUBLIC_VAPID_PUBLIC_KEY=${NEXT_PUBLIC_VAPID_PUBLIC_KEY}
+ENV NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=${NEXT_PUBLIC_GOOGLE_MAPS_API_KEY}
+
+RUN pnpm --filter {{name}}-web build
+
+# =============================================================================
+# WEB PRODUCTION TARGET
+# =============================================================================
+FROM node:22-alpine AS web-production
+
+# Install runtime dependencies for Next.js image optimization (sharp)
+RUN apk add --no-cache cairo jpeg pango giflib libwebp
+
+# Install pnpm for runtime scripts
+RUN corepack enable && corepack prepare pnpm@10.18.2 --activate
+
+WORKDIR /app
+ENV NODE_ENV=production
+
+# Copy built files from web-builder
+COPY --from=web-builder /app/package.json /app/pnpm-lock.yaml /app/pnpm-workspace.yaml ./
+COPY --from=web-builder /app/packages/shared ./packages/shared
+COPY --from=web-builder /app/apps/web ./apps/web
+
+# Install only production dependencies
+RUN pnpm install --no-frozen-lockfile --prod --ignore-scripts
+
+WORKDIR /app/apps/web
+
+# Expose port (set via build arg; defaults to 3401 for local compose)
+ARG PORT=3401
+EXPOSE ${PORT}
+
+# Production command
+CMD ["pnpm", "--filter", "{{name}}-web", "run", "start"]

package/template/README.md

@@ -0,0 +1 @@
+# {{name}}

package/template/apps/api/.prettierrc

@@ -0,0 +1,12 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "quoteProps": "as-needed",
+  "singleQuote": false,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "always"
+}

package/template/apps/api/eslint.config.mjs

@@ -0,0 +1,54 @@
+import { FlatCompat } from "@eslint/eslintrc";
+import js from "@eslint/js";
+import typescriptEslintEslintPlugin from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import globals from "globals";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default [
+  {
+    ignores: ["**/eslint.config.mjs", "dist/**/*"],
+  },
+  ...compat.extends("plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"),
+  {
+    plugins: {
+      "@typescript-eslint": typescriptEslintEslintPlugin,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+
+      parser: tsParser,
+      ecmaVersion: 5,
+      sourceType: "module",
+
+      parserOptions: {
+        project: path.resolve(__dirname, "tsconfig.json"),
+        tsconfigRootDir: path.resolve(__dirname),
+      },
+    },
+
+    rules: {
+      "@typescript-eslint/interface-name-prefix": "off",
+      "@typescript-eslint/explicit-function-return-type": "off",
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-var-requires": "off",
+      "@typescript-eslint/no-require-imports": "off",
+      "@typescript-eslint/no-empty-object-type": "off",
+      "@typescript-eslint/no-unused-expressions": "off",
+    },
+  },
+];

package/template/apps/api/jest.config.js

@@ -0,0 +1,29 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  moduleFileExtensions: ['ts', 'js', 'json'],
+  rootDir: '.',
+  testRegex: 'src/.*\\.spec\\.ts$',
+  transform: {
+    '^.+\\.ts$': [
+      'ts-jest',
+      {
+        tsconfig: {
+          baseUrl: '.',
+          paths: {
+            'src/*': ['src/*']
+          }
+        }
+      }
+    ]
+  },
+  collectCoverageFrom: ['src/**/*.(t|j)s'],
+  coverageDirectory: './coverage',
+  moduleNameMapper: {
+    '^src/(.*)$': '<rootDir>/src/$1'
+  },
+  moduleDirectories: ['node_modules', '<rootDir>'],
+  testTimeout: 30000,
+  setupFilesAfterEnv: [],
+  verbose: true
+};

package/template/apps/api/nest-cli.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "assets": [
+      {
+        "include": "i18n/**/*.json",
+        "outDir": "./dist",
+        "watchAssets": true
+      }
+    ]
+  }
+}

package/template/apps/api/package.json

@@ -0,0 +1,155 @@
+{
+  "author": "",
+  "dependencies": {
+    "@carlonicora/nestjs-neo4jsonapi": "1.2.0",
+    "@aws-sdk/client-s3": "^3.948.0",
+    "@aws-sdk/s3-request-presigner": "^3.948.0",
+    "@azure/msal-node": "^3.8.4",
+    "@azure/openai": "^2.0.0",
+    "@azure/storage-blob": "^12.29.1",
+    "@fastify/multipart": "^9.3.0",
+    "@fastify/static": "^8.3.0",
+    "@fastify/swagger": "^9.6.1",
+    "@getbrevo/brevo": "^3.0.1",
+    "@langchain/aws": "^1.1.0",
+    "@langchain/community": "^1.0.7",
+    "@langchain/core": "^1.1.4",
+    "@langchain/langgraph": "^1.0.4",
+    "@langchain/ollama": "^1.0.3",
+    "@langchain/openai": "^1.1.3",
+    "@langchain/textsplitters": "^1.0.1",
+    "@microsoft/microsoft-graph-client": "^3.0.7",
+    "@microsoft/microsoft-graph-types": "^2.43.1",
+    "@nestjs/bullmq": "^11.0.4",
+    "@nestjs/cli": "^11.0.14",
+    "@nestjs/common": "^11.1.9",
+    "@nestjs/config": "^4.0.2",
+    "@nestjs/core": "^11.1.9",
+    "@nestjs/event-emitter": "^3.0.1",
+    "@nestjs/jwt": "^11.0.2",
+    "@nestjs/microservices": "^11.1.9",
+    "@nestjs/passport": "^11.0.5",
+    "@nestjs/platform-fastify": "^11.1.9",
+    "@nestjs/platform-socket.io": "^11.1.9",
+    "@nestjs/schedule": "^6.1.0",
+    "@nestjs/swagger": "^11.2.3",
+    "@nestjs/throttler": "^6.5.0",
+    "@nestjs/websockets": "^11.1.9",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.208.0",
+    "@opentelemetry/instrumentation-fastify": "^0.53.0",
+    "@opentelemetry/instrumentation-http": "^0.208.0",
+    "@opentelemetry/instrumentation-nestjs-core": "^0.55.0",
+    "@opentelemetry/resources": "^2.2.0",
+    "@opentelemetry/sdk-node": "^0.208.0",
+    "@opentelemetry/semantic-conventions": "^1.38.0",
+    "@{{name}}/shared": "workspace:*",
+    "@sendgrid/mail": "^8.1.6",
+    "adm-zip": "^0.5.16",
+    "async": "^3.2.6",
+    "axios": "^1.13.2",
+    "bcryptjs": "^3.0.3",
+    "bullmq": "^5.66.0",
+    "cheerio": "^1.1.2",
+    "class-transformer": "^0.5.1",
+    "class-validator": "^0.14.3",
+    "dotenv": "^17.2.3",
+    "fast-xml-parser": "^5.3.3",
+    "fastify": "^5.6.2",
+    "handlebars": "^4.7.8",
+    "ioredis": "^5.8.2",
+    "jsdom": "^27.3.0",
+    "jszip": "^3.10.1",
+    "langchain": "^1.1.5",
+    "lodash": "^4.17.21",
+    "marked": "^17.0.1",
+    "mathjs": "^15.1.0",
+    "mime-types": "^3.0.2",
+    "natural": "^8.1.0",
+    "neo4j-driver": "^6.0.1",
+    "nestjs-cls": "^6.1.0",
+    "nestjs-i18n": "^10.6.0",
+    "node-tesseract-ocr": "^2.2.1",
+    "nodemailer": "^7.0.11",
+    "officeparser": "^5.2.2",
+    "openai": "^6.10.0",
+    "passport": "^0.7.0",
+    "passport-jwt": "^4.0.1",
+    "pdf-parse": "^2.4.5",
+    "pdf2pic": "^3.2.0",
+    "pdfjs-dist": "^5.4.449",
+    "pino": "^10.1.0",
+    "pino-loki": "^2.6.0",
+    "pino-pretty": "^13.1.3",
+    "pino-roll": "^4.0.0",
+    "qs": "^6.14.0",
+    "reflect-metadata": "^0.2.2",
+    "rrule": "^2.8.1",
+    "rxjs": "^7.8.2",
+    "sharp": "^0.34.5",
+    "socket.io": "^4.8.1",
+    "tslib": "^2.8.1",
+    "turndown": "^7.2.2",
+    "uuid": "^13.0.0",
+    "web-push": "^3.6.7",
+    "windows-iana": "^5.1.0",
+    "xlsx-republish": "^0.20.3",
+    "zod-to-json-schema": "^3.25.0"
+  },
+  "description": "",
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@nestjs/schematics": "^11.0.9",
+    "@nestjs/testing": "^11.1.9",
+    "@types/jest": "^30.0.0",
+    "@types/jsdom": "^27.0.0",
+    "@types/microsoft-graph": "^2.40.1",
+    "@types/supertest": "^6.0.3",
+    "@types/web-push": "^3.6.4",
+    "@typescript-eslint/eslint-plugin": "^8.49.0",
+    "@typescript-eslint/parser": "^8.49.0",
+    "commander": "^14.0.2",
+    "esbuild": "^0.27.1",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "glob": "^13.0.0",
+    "globals": "^16.5.0",
+    "jest": "^30.2.0",
+    "nodemon": "^3.1.11",
+    "source-map-support": "^0.5.21",
+    "supertest": "^7.1.4",
+    "testcontainers": "^11.10.0",
+    "ts-jest": "^29.4.6",
+    "ts-loader": "^9.5.4",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths": "^4.2.0"
+  },
+  "engines": {
+    "node": "22"
+  },
+  "license": "UNLICENSED",
+  "name": "{{name}}-api",
+  "private": true,
+  "scripts": {
+    "build": "nest build",
+    "dev": "nodemon --watch src --ext ts --exec \"ts-node -r tsconfig-paths/register src/main.ts --mode=api\"",
+    "dev:worker": "nodemon --watch src --ext ts --exec \"ts-node -r tsconfig-paths/register src/main.ts --mode=worker\"",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "start": "nest start --mode=api",
+    "start:debug": "nest start --debug --watch",
+    "start:dev": "nodemon --watch src --ext ts --exec \"ts-node -r tsconfig-paths/register src/main.ts --mode=api\"",
+    "start:prod": "node --max-old-space-size=6144 dist/main --mode=api",
+    "start:worker": "nest start --mode=worker",
+    "start:worker:dev": "nodemon --watch src --ext ts --exec \"ts-node -r tsconfig-paths/register src/main.ts --mode=worker\"",
+    "start:worker:prod": "node --max-old-space-size=6144 dist/main --mode=worker",
+    "test": "jest",
+    "test:cov": "jest --coverage",
+    "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
+    "test:e2e": "jest --config ./test/jest-e2e.json --verbose=false --noStackTrace",
+    "test:e2e:debug": "jest --config ./test/jest-e2e.json",
+    "test:watch": "jest --watch"
+  },
+  "version": "1.0.0"
+}

package/template/apps/api/src/config/config.ts

@@ -0,0 +1,17 @@
+import { baseConfig } from "@carlonicora/nestjs-neo4jsonapi";
+import { JobName } from "src/config/enums/job.name";
+import { QueueId } from "src/config/enums/queue.id";
+import { ConfigInterface } from "src/config/interfaces/config.interface";
+
+export default (): ConfigInterface => {
+  return {
+    ...baseConfig,
+    chunkQueues: {
+      queueIds: Object.values(QueueId),
+    },
+    contentTypes: {
+      types: [],
+    },
+    jobNames: JobName,
+  };
+};

package/template/apps/api/src/config/enums/job.name.ts

@@ -0,0 +1,6 @@
+export const JobName = {
+  process: {
+    chunk: "process_chunk",
+  },
+  notifications: {},
+} as const;

package/template/apps/api/src/config/enums/queue.id.ts

@@ -0,0 +1,3 @@
+export enum QueueId {
+  CHUNK = "chunk",
+}

package/template/apps/api/src/config/interfaces/config.interface.ts

@@ -0,0 +1,3 @@
+import { BaseConfigInterface } from "@carlonicora/nestjs-neo4jsonapi";
+
+export interface ConfigInterface extends BaseConfigInterface {}

package/template/apps/api/src/features/features.modules.ts

@@ -0,0 +1,6 @@
+import { Module } from "@nestjs/common";
+
+@Module({
+  imports: [],
+})
+export class FeaturesModules {}

package/template/apps/api/src/i18n/en/notifications.json

@@ -0,0 +1,3 @@
+{
+  "notification": {}
+}

package/template/apps/api/src/main.ts

@@ -0,0 +1,23 @@
+import * as dotenv from "dotenv";
+import * as path from "path";
+
+// Load environment variables FIRST (before any library imports)
+dotenv.config({ path: path.resolve(__dirname, "../../../.env") });
+
+import { bootstrap } from "@carlonicora/nestjs-neo4jsonapi";
+
+import config from "src/config/config";
+import { FeaturesModules } from "./features/features.modules";
+
+// Queue configuration is now via baseConfig.chunkQueues in config/config.ts
+bootstrap({
+  appModules: [FeaturesModules],
+  i18n: {
+    fallbackLanguage: "en",
+    path: path.join(__dirname, "i18n"),
+  },
+  config: config,
+  contentExtension: {
+    additionalRelationships: [],
+  },
+});

package/template/apps/api/src/neo4j.migrations/20250901_001.ts

@@ -0,0 +1,33 @@
+/**
+ * This migration creates the initial set of features in the database.
+ */
+
+import { MigrationInterface } from "@carlonicora/nestjs-neo4jsonapi";
+import { featureQuery, roleQuery } from "src/neo4j.migrations/queries/migration.queries";
+
+export const migration: MigrationInterface[] = [
+  {
+    query: roleQuery,
+    queryParams: {
+      roleId: "53394cb8-1e87-11ef-8b48-bed54b8f8aba",
+      roleName: "Administrators",
+      isSelectable: false,
+    },
+  },
+  {
+    query: roleQuery,
+    queryParams: {
+      roleId: "2e1eee00-6cba-4506-9059-ccd24e4ea5b0",
+      roleName: "Company Administrator",
+      isSelectable: true,
+    },
+  },
+  {
+    query: featureQuery,
+    queryParams: {
+      featureId: "17036fb0-060b-4c83-a617-f32259819783",
+      featureName: "Common",
+      isProduction: true,
+    },
+  },
+];