@kreciko/setup-templates 0.1.0

package/README.md

@@ -0,0 +1,109 @@
+# setup-templates
+
+🚀 Zero-config CLI for quickly adding standard project files to an existing repository.
+
+> Perfect for use with **npx** - no installation, no configuration, no pain.
+
+## ✨ What is it?
+
+`setup-templates` is a CLI tool that adds ready-made, proven configuration templates to your project in seconds.
+Instead of copying files between repositories - run one command and choose what you want to install.
+
+## 🧰 What's included?
+
+- **Express** - TypeScript configuration for Express.js
+- **Frontend** - React + Vite + TypeScript (development & build only)
+- **Docker** - `Dockerfile` and `docker-compose` for development and production
+- **Nginx** - production server for frontend build and API reverse proxy
+- **Base** - MIT license, Biome config and .gitignore
+
+## ▶️ Quick start
+
+```bash
+npx @kretostan/setup-templates
+```
+
+That's it. The CLI will launch an interactive menu where you select which templates to add to your project.
+
+### 🔁 Specific version (reproducible builds)
+
+```bash
+npx @kretostan/setup-templates@1.2.3
+```
+
+### 🧑‍💻 Local usage (teams / CI)
+
+```bash
+npm install --save-dev @kretostan/setup-templates
+npx @kretostan/setup-templates
+```
+
+## 📦 What can you install?
+
+You can safely install multiple templates in the same project.
+Depending on the selected templates, setup-templates will add the following files and directories to your project.
+Existing files are not overwritten without confirmation.
+
+## 📂 What files will be created?
+
+### 🧱 Base
+```
+├─ .gitignore
+├─ biome.json
+└─ LICENSE
+```
+
+### 🐳 Docker
+```
+├─ Dockerfile.backend
+├─ Dockerfile.frontend
+├─ .dockerignore
+├─ Makefile
+├─ compose.dev.yaml
+└─ compose.yaml
+```
+
+### 🖥 Express.js
+```
+└─ tsconfig.json
+```
+
+> Express template provides a minimal TypeScript setup, intended to be extended by the user.
+
+### 🌐 Frontend (React + Vite)
+```
+├─ tsconfig.app.json
+├─ tsconfig.json
+├─ tsconfig.node.json
+└─ vite.config.ts
+```
+
+### 🌍 Nginx
+```
+└─ nginx.conf
+```
+
+## 💡 Why setup-templates?
+
+- ⚡ works instantly via npx
+- 📦 no manual file copying
+- 🧭 interactive template selection
+- 🧩 easy to extend with new presets
+- 🧼 consistent project structure across your team
+
+## ⚙️ Requirements
+
+- Node.js >= 24
+- npm
+
+> (Node 24+ required due to modern Node APIs)
+
+
+## 🛠️ Libraries used
+
+- chalk - colored terminal output
+- ora - spinners
+- prompts - interactive menu
+
+## 📄 License
+MIT

package/bin/setup-templates.mjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { main } from "../src/index.mjs";
+
+main(process.argv).catch(error => {
+  console.error(error);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@kreciko/setup-templates",
+  "version": "0.1.0",
+  "description": "Installer that adds project template files into an existing repo",
+  "type": "module",
+  "bin": {
+    "setup-templates": "bin/setup-templates.mjs"
+  },
+  "files": [
+    "bin",
+    "templates",
+    "src"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "ora": "^9.1.0",
+    "prompts": "^2.4.2"
+  }
+}

package/src/config.mjs

@@ -0,0 +1,7 @@
+import path from "node:path";
+import {fileURLToPath} from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+export const TEMPLATES_DIR = path.join(__dirname, "..", "templates");

package/src/index.mjs

@@ -0,0 +1,113 @@
+import path from "node:path";
+import ora from "ora";
+import prompts from "prompts";
+import chalk from "chalk";
+import { copyDir, ensureProjectFolder } from "./utils/fs.mjs";
+import { TEMPLATES_DIR } from "./config.mjs";
+import { setTimeout as sleep } from "node:timers/promises";
+
+function safeCwd() {
+  try {
+    return process.cwd();
+  } catch {
+    const fallback = process.env.INIT_CWD || process.env.PWD || process.env.HOME || "/";
+    process.chdir(fallback);
+    return process.cwd();
+  }
+}
+
+export async function main(argv) {
+  const cwd = process.cwd();
+  ensureProjectFolder(cwd);
+
+  const args = new Set(argv.slice(2));
+  const hasFlags = [...args].some(arg => arg.startsWith("--"));
+  const selections = {
+    base: args.has("--base"),
+    docker: args.has("--docker"),
+    nginx: args.has("--nginx"),
+    express: args.has("--express"),
+    frontend: args.has("--frontend"),
+    force: args.has("--force"),
+  };
+
+  const spinner = ora();
+  if (!hasFlags) {
+    const response = await prompts([
+      {
+        type: "multiselect",
+        name: "features",
+        message: " What config would you like to include?",
+        choices: [
+          { title: chalk.white("Base"), value: "base" },
+          { title: chalk.blueBright("Docker (Frontend + Backend)"), value: "docker" },
+          { title: chalk.green("Nginx"), value: "nginx" },
+          { title: chalk.yellowBright("Express.js (ESM + TS)"), value: "express"},
+          { title: chalk.magentaBright("React + Vite + TS"), value: "frontend" },
+        ],
+        hint: "Space to select. Return to submit.",
+        instructions: false,
+        min: 1,
+      },
+      {
+        type: "confirm",
+        name: "force",
+        message: " Do you want to overwrite existing files?",
+        initial: false,
+      },
+    ], {
+      onCancel: () => {
+        spinner.fail(chalk.redBright(" Canceled"));
+        process.exit(0);
+      }
+    });
+
+    const set = new Set(response.features ?? []);
+    selections.base = set.has("base");
+    selections.docker = set.has("docker");
+    selections.nginx = set.has("nginx");
+    selections.express = set.has("express");
+    selections.frontend = set.has("frontend");
+    selections.force = !!response.force;
+  }
+
+  spinner.start(chalk.whiteBright("Copying files"));
+  await sleep(1000);
+  let copied = 0;
+
+  let warning = "";
+  let info = "";
+  const rootCheck = new Set(["base", "docker", "nginx",]);
+  const frontCheck = new Set(["base", "frontend"]);
+  const backCheck = new Set(["base", "express"]);
+  Object.keys(selections).forEach(option => {
+    if (!selections.force) warning = " Skipping files due to disabled force option.";
+    if (!selections[option]) return;
+    info = ensureProjectFolder(cwd);
+    switch (info) {
+      case "root":
+        rootCheck.has(option)
+          ? copied += copyDir(path.join(TEMPLATES_DIR, option), cwd, selections.force)
+          : info = " Some options are unavailable on this level.";
+        break;
+      case "frontend":
+        frontCheck.has(option)
+          ? copied += copyDir(path.join(TEMPLATES_DIR, option), cwd, selections.force)
+          : info = " Some options are unavailable on this level.";
+        break;
+      case "backend":
+        backCheck.has(option)
+          ? copied += copyDir(path.join(TEMPLATES_DIR, option), cwd, selections.force)
+          : info = " Some options are unavailable on this level.";
+        break;
+      default:
+        console.log("Error while validating folder.");
+    }
+  });
+
+  if (warning.length > 0) spinner.warn(chalk.yellow(warning));
+  if (info.length > 0) spinner.info(chalk.blueBright(info));
+
+  spinner.info(chalk.whiteBright(` Files copied: ${copied}`));
+  spinner.succeed(chalk.whiteBright(" All configuration information you can find in README.md"));
+}

package/src/utils/fs.mjs

@@ -0,0 +1,56 @@
+import fs from "fs";
+import path from "node:path";
+import ora from "ora";
+import chalk from "chalk";
+
+function exists(path) {
+  try { fs.accessSync(path); return true; } catch { return false; }
+}
+
+export function ensureProjectFolder(cwd) {
+  const spinner = ora();
+  if (!exists(path.join(cwd, "package.json"))) {
+    spinner.fail(chalk.red(" Package.json is missing."));
+    process.exit(1);
+  }
+  const pkgPath = path.join(cwd, "package.json");
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+
+  if (pkg.workspaces && !cwd.endsWith("backend") && !cwd.endsWith("frontend")) return "root";
+  if ((pkg.dependencies || pkg.devDependencies) && cwd.endsWith("backend")) return "backend";
+  if ((pkg.dependencies || pkg.devDependencies) && cwd.endsWith("frontend")) return "frontend";
+
+  return "";
+}
+
+function listFiles(directory) {
+  let out = [];
+  for (const file of fs.readdirSync(directory, { withFileTypes: true })) {
+    const fullPath = path.join(directory, file.name);
+    if (file.isDirectory()) {
+      out.push(...listFiles(fullPath));
+    } else {
+      out.push(fullPath);
+    }
+  }
+  return out;
+}
+
+export function copyDir(srcDir, destDir, force = false) {
+  const files = listFiles(srcDir);
+  let count  = 0;
+
+  for (const srcFile of files) {
+    const relative = path.relative(srcDir, srcFile);
+    const destFile = path.join(destDir, relative);
+    const destDirName = path.dirname(destFile);
+
+    if (exists(destFile) && !force) {
+      continue;
+    }
+    fs.mkdirSync(destDirName, { recursive: true });
+    fs.copyFileSync(srcFile, destFile);
+    count++;
+  }
+  return count;
+}

package/templates/base/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright © 2025 Jakub Kret
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/templates/base/biome.json

@@ -0,0 +1,42 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.3.13/schema.json",
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
+	},
+	"files": {
+		"ignoreUnknown": false
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "tab"
+	},
+	"css": {
+		"parser": {
+			"tailwindDirectives": true
+		}
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true,
+			"correctness": {
+				"useUniqueElementIds": "off"
+			}
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "double"
+		}
+	},
+	"assist": {
+		"enabled": true,
+		"actions": {
+			"source": {
+				"organizeImports": "on"
+			}
+		}
+	}
+}

package/templates/docker/.dockerignore

@@ -0,0 +1,34 @@
+# Dependencies
+node_modules
+.pnpm-store
+.yarn
+
+# Logs
+*.log
+npm-debug.log*
+yarn-error.log*
+
+# Build outputs (if you build in Docker)
+dist
+build
+.out
+.next
+.nuxt
+coverage
+
+# Env
+.env
+.env.*
+!.env.example
+
+# VCS / IDE / OS
+.git
+.gitignore
+.vscode
+.idea
+.DS_Store
+
+# temp / cache
+tmp
+temp
+.cache

package/templates/docker/Dockerfile.backend

@@ -0,0 +1,27 @@
+FROM node:alpine AS deps
+WORKDIR /app
+COPY package.json package-lock.json ./
+COPY frontend/package.json ./frontend/package.json
+COPY backend/package.json ./backend/package.json
+RUN npm install
+
+FROM deps AS dev
+WORKDIR /app
+COPY backend ./backend
+EXPOSE 3001
+CMD ["npm", "--workspace", "backend", "run", "dev"]
+
+FROM deps AS build
+WORKDIR /app
+COPY backend ./backend
+RUN npm --workspace backend run build
+
+FROM node:alpine AS prod
+WORKDIR /app
+COPY package.json package-lock.json ./
+COPY frontend/package.json ./frontend/package.json
+COPY backend/package.json ./backend/package.json
+RUN npm ci --omit=dev
+COPY --from=build /app/backend/dist ./backend/dist
+EXPOSE 3000
+CMD ["npm", "--workspace", "backend", "start"]

package/templates/docker/Dockerfile.frontend

@@ -0,0 +1,21 @@
+FROM node:alpine AS deps
+WORKDIR /app
+COPY package.json package-lock.json ./
+COPY frontend/package.json ./frontend/package.json
+COPY backend/package.json ./backend/package.json
+RUN npm install
+
+FROM deps AS dev
+WORKDIR /app
+COPY frontend ./frontend
+EXPOSE 5173
+CMD ["npm", "--workspace", "frontend", "run", "dev"]
+
+FROM deps AS build
+WORKDIR /app
+COPY frontend ./frontend
+RUN npm --workspace frontend run build
+
+FROM nginx:alpine AS prod
+COPY --from=build /app/frontend/dist /usr/share/nginx/html
+EXPOSE 80

package/templates/docker/Makefile

@@ -0,0 +1,23 @@
+dev-up:
+	docker compose -p app-dev -f compose.dev.yaml --env-file .env.development up --build -d
+
+dev-start:
+	docker compose -p app-dev -f compose.dev.yaml --env-file .env.development up --build -d
+
+dev-stop:
+	docker compose -p app-dev stop
+
+dev-down:
+	docker compose -p app-dev down
+
+prod-up:
+	docker compose -p app-prod -f compose.yaml --env-file .env up --build -d
+
+prod-start:
+	docker compose -p app-prod -f compose.yaml --env-file .env up --build -d
+
+prod-stop:
+	docker compose -p app-prod stop
+
+prod-down:
+	docker compose -p app-prod down

package/templates/docker/compose.dev.yaml

@@ -0,0 +1,41 @@
+services:
+  backend:
+    build:
+      context: .
+      target: dev
+      dockerfile: Dockerfile.backend
+    ports:
+      - "${BACKEND_PORT:-3001}:3001"
+    env_file:
+      - ./.env.development
+    environment:
+#      - NODE_ENV=${NODE_ENV:-development}
+      - PORT=${BACKEND_PORT:-3001}
+    volumes:
+      - ./backend:/app/backend
+      - backend_node_modules:/app/backend/node_modules
+    healthcheck:
+      test: ["CMD-SHELL", "exit 0"]
+      disable: true
+
+  frontend:
+    build:
+      context: .
+      target: dev
+      dockerfile: Dockerfile.frontend
+    ports:
+      - "${FRONTEND_PORT:-5173}:5173"
+    env_file:
+      - ./.env.development
+    environment:
+      - NODE_ENV=${NODE_ENV:-development}
+      - CHOKIDAR_USEPOLLING=true
+    volumes:
+      - ./frontend:/app/frontend
+      - frontend_node_modules:/app/frontend/node_modules
+    depends_on:
+      - backend
+
+volumes:
+  backend_node_modules:
+  frontend_node_modules:

package/templates/docker/compose.yaml

@@ -0,0 +1,31 @@
+services:
+  backend:
+    build:
+      context: .
+      target: prod
+      dockerfile: Dockerfile.backend
+    environment:
+#      - NODE_ENV=production
+      - PORT=3000
+      - APP_URL=http://localhost
+    expose:
+      - "3000"
+    healthcheck:
+      test: ["CMD-SHELL", "node -e \"require('http').get('http://localhost:3000/health',res=>process.exit(res.statusCode===200?0:1)).on('error',()=>process.exit(1))\""]
+      interval: 5s
+      timeout: 2s
+      retries: 10
+      start_period: 5s
+
+  frontend:
+    build:
+      context: .
+      target: prod
+      dockerfile: Dockerfile.frontend
+    ports:
+      - "80:80"
+    volumes:
+      - ./nginx.conf:/etc/nginx/conf.d/default.conf:ro
+    depends_on:
+      backend:
+        condition: service_healthy

package/templates/express/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    "module": "NodeNext",
+    "target": "ESNext",
+    "moduleResolution": "nodenext",
+
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    "noUnusedLocals": true,
+    "noImplicitReturns": true,
+    "esModuleInterop": true,
+
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": false,
+    "strict": true,
+    "types": ["node"],
+
+    "baseUrl": "../backend",
+    "paths": { "@/*": ["src/*"] }
+  },
+  "compileOnSave": true,
+  "include": ["src"]
+}

package/templates/frontend/tsconfig.app.json

@@ -0,0 +1,26 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
+    "target": "ES2022",
+    "useDefineForClassFields": true,
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "types": ["vite/client"],
+    "skipLibCheck": true,
+
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["src"]
+}

package/templates/frontend/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.app.json" },
+    { "path": "./tsconfig.node.json" }
+  ],
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["src/*"]
+    }
+  }
+}

package/templates/frontend/tsconfig.node.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "target": "ES2023",
+    "lib": ["ES2023"],
+    "module": "ESNext",
+    "types": ["node"],
+    "skipLibCheck": true,
+
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "moduleDetection": "force",
+    "noEmit": true,
+
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "erasableSyntaxOnly": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true
+  },
+  "include": ["vite.config.ts"]
+}

package/templates/frontend/vite.config.ts

@@ -0,0 +1,17 @@
+import * as path from "node:path";
+import react from "@vitejs/plugin-react-swc";
+import { defineConfig } from 'vite';
+
+// https://vite.dev/config/
+export default defineConfig({
+  plugins: [react()],
+  server: {
+    host: "0.0.0.0",
+    port: 5173
+  },
+  resolve: {
+    alias: {
+      "@": path.resolve(__dirname, "./src"),
+    },
+  },
+})

package/templates/nginx/nginx.conf

@@ -0,0 +1,67 @@
+  server {
+    listen 80;
+
+    # Root directory where the built frontend (HTML/CSS/JS) files are located
+    root /usr/share/nginx/html;
+
+    # Default file to serve
+    index index.html;
+
+    # Gzip compression
+    gzip on;
+    gzip_comp_level 5;      # Compression on level 1–9 (5 = sweet spot)
+    gzip_min_length 1024;   # Do not compress very small files
+    gzip_vary on;           # Add header Vary: Accept-Encoding
+
+    # MIME types
+    gzip_types
+      text/plain
+      text/css
+      application/javascript
+      application/json
+      application/xml
+      text/xml
+      image/svg+xml;
+
+    # Cache static assets for a long time (1 year)
+    # Good for production builds where filenames include hashes (e.g. main.abc123.js)
+    location ~* \.(js|css|png|jpg|jpeg|gif|svg|woff2)$ {
+      expires 1y;
+      add_header Cache-Control "public, immutable";
+      try_files $uri =404;
+    }
+
+    # Main frontend route — needed for SPA frameworks (React, Vue, Svelte, etc.)
+    # Any unknown route falls back to index.html
+    location / {
+      try_files $uri /index.html;
+    }
+
+    # API reverse proxy — forwards /api/* requests to backend service
+    # "backend" should match the service name in docker-compose (or another host)
+    location ^~ /api/ {
+      # Forward requests to the backend service
+        # Trailing slash removes /api prefix before passing the request upstream
+        proxy_pass http://backend:3000/;
+
+        # Preserve original request information
+        # Allows backend to know the real host, client IP and protocol
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+
+        # Enable WebSocket and other connection upgrades
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+
+        # Prevent hanging connections and slow upstreams
+        proxy_connect_timeout 5s;
+        proxy_send_timeout 60s;
+        proxy_read_timeout 60s;
+
+        # Maximum allowed request body size (e.g. file uploads)
+        client_max_body_size 20m;
+    }
+  }