create-stb 1.0.1

package/dist/create-stb.d.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+export declare function checkNodeVersion(minMajor?: number): void;
+export declare function createProjectDirectory(projectPath: string): void;
+export declare function copyDir(src: string, dest: string): void;
+export declare function updatePackageJson(projectPath: string, projectName: string): void;
+export declare function updateServerlessYml(projectPath: string, projectName: string): void;
+export declare function main(): Promise<void>;
+declare const _default: {
+    checkNodeVersion: typeof checkNodeVersion;
+    createProjectDirectory: typeof createProjectDirectory;
+    copyDir: typeof copyDir;
+    updatePackageJson: typeof updatePackageJson;
+    main: typeof main;
+};
+export default _default;

package/dist/create-stb.js

@@ -0,0 +1,122 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkNodeVersion = checkNodeVersion;
+exports.createProjectDirectory = createProjectDirectory;
+exports.copyDir = copyDir;
+exports.updatePackageJson = updatePackageJson;
+exports.updateServerlessYml = updateServerlessYml;
+exports.main = main;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const child_process_1 = require("child_process");
+// Progress display helpers
+function writeLine(msg) {
+    const width = process.stdout.columns || 80;
+    process.stdout.write(`\r${" ".repeat(width)}\r${msg}`);
+}
+function clearLine() {
+    const width = process.stdout.columns || 80;
+    process.stdout.write(`\r${" ".repeat(width)}\r`);
+}
+function step(label) {
+    writeLine(label + "...");
+}
+function doneStep() {
+    clearLine();
+}
+// Ensure required Node version
+function checkNodeVersion(minMajor = 20) {
+    const [major] = process.version.replace("v", "").split(".");
+    if (Number(major) < minMajor)
+        throw new Error(`Node.js v${minMajor}+ required`);
+}
+// Create an empty directory (or error if not empty)
+function createProjectDirectory(projectPath) {
+    if (fs_1.default.existsSync(projectPath)) {
+        if (fs_1.default.readdirSync(projectPath).length === 0)
+            return;
+        throw new Error(`Directory "${projectPath}" exists and is not empty.`);
+    }
+    fs_1.default.mkdirSync(projectPath, { recursive: true });
+}
+// Recursively copy everything, including dotfiles and subfolders
+function copyDir(src, dest) {
+    if (!fs_1.default.existsSync(dest))
+        fs_1.default.mkdirSync(dest, { recursive: true });
+    for (const entry of fs_1.default.readdirSync(src, { withFileTypes: true })) {
+        const srcPath = path_1.default.join(src, entry.name);
+        const destPath = path_1.default.join(dest, entry.name);
+        if (entry.isDirectory()) {
+            copyDir(srcPath, destPath);
+        }
+        else {
+            fs_1.default.copyFileSync(srcPath, destPath);
+        }
+    }
+}
+// Only update basic project info in package.json
+function updatePackageJson(projectPath, projectName) {
+    const file = path_1.default.join(projectPath, "package.json");
+    if (!fs_1.default.existsSync(file))
+        return;
+    const pkg = JSON.parse(fs_1.default.readFileSync(file, "utf8"));
+    pkg.name = projectName;
+    pkg.description = `${projectName} app description`;
+    fs_1.default.writeFileSync(file, JSON.stringify(pkg, null, 2));
+}
+function updateServerlessYml(projectPath, projectName) {
+    const serverlessPath = path_1.default.join(projectPath, "serverless.yml");
+    if (!fs_1.default.existsSync(serverlessPath))
+        return;
+    let content = fs_1.default.readFileSync(serverlessPath, "utf8");
+    content = content.replace(/^service:.*$/m, `service: ${projectName}`);
+    fs_1.default.writeFileSync(serverlessPath, content);
+}
+// Main CLI flow
+async function main() {
+    const name = process.argv[2];
+    if (!name) {
+        console.error("Please provide a project name.");
+        process.exit(1);
+    }
+    const projectPath = path_1.default.resolve(process.cwd(), name);
+    const boilerplateSrc = path_1.default.resolve(__dirname, "..", "serverless");
+    step("Checking Node version");
+    checkNodeVersion();
+    doneStep();
+    step("Creating project directory");
+    createProjectDirectory(projectPath);
+    doneStep();
+    step("Copying boilerplate files");
+    copyDir(boilerplateSrc, projectPath);
+    doneStep();
+    step("Updating package.json");
+    updatePackageJson(projectPath, name);
+    doneStep();
+    step("Updating serverless.yml");
+    updateServerlessYml(projectPath, name);
+    doneStep();
+    step("Installing packages");
+    (0, child_process_1.execSync)("npm install --silent", { cwd: projectPath, stdio: "inherit" });
+    doneStep();
+    clearLine();
+    console.log(`\nInstallation complete\n\nNext steps:\n\n  cd ${name}\n  npm run offline\n`);
+}
+exports.default = {
+    checkNodeVersion,
+    createProjectDirectory,
+    copyDir,
+    updatePackageJson,
+    main,
+};
+if (require.main === module) {
+    main().catch((err) => {
+        clearLine();
+        console.error("Error:", err.message);
+        process.exit(1);
+    });
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "create-stb",
+  "version": "1.0.1",
+  "description": "A CLI to quickly scaffold a Serverless TypeScript Boilerplate project.",
+  "license": "ISC",
+  "readme": "README.md",
+  "engines": {
+    "node": ">=20.0.0",
+    "npm": ">=10.0.0"
+  },
+  "bin": {
+    "create-stb": "./dist/create-stb.js"
+  },
+  "files": [
+    "dist/create-stb.js",
+    "dist/create-stb.d.ts",
+    "README.md",
+    "LICENSE",
+    "package.json",
+    "serverless"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "format": "prettier --write .",
+    "test": "jest --roots ./bin"
+  },
+  "devDependencies": {
+    "@types/jest": "30.0.0",
+    "@types/node": "20.19.25",
+    "jest": "^30.2.0",
+    "prettier": "3.6.2",
+    "ts-jest": "29.4.5",
+    "typescript": "5.9.3"
+  },
+  "homepage": "https://github.com/SamNewhouse/create-stb",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SamNewhouse/create-stb.git"
+  },
+  "bugs": {
+    "url": "https://github.com/SamNewhouse/create-stb/issues"
+  },
+  "author": {
+    "name": "Sam Newhouse",
+    "url": "https://github.com/SamNewhouse"
+  },
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/SamNewhouse"
+  },
+  "keywords": [
+    "create-stb",
+    "serverless",
+    "typescript",
+    "boilerplate",
+    "starter",
+    "scaffold",
+    "cli",
+    "template",
+    "starter-kit"
+  ]
+}

package/serverless/.env.example

@@ -0,0 +1,14 @@
+# AWS credentials (dummy for local, ignored by DynamoDB Local)
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=eu-west-2
+AWS_REGION_FALLBACK=eu-west-1
+
+# DynamoDB Setup
+DYNAMODB_ENDPOINT=http://localhost:8000
+
+# If you use other secrets (JWT, third party APIs etc.), add those here too:
+JWT_SECRET=
+
+# Current environment/stage
+STAGE=dev

package/serverless/.prettierignore

@@ -0,0 +1,20 @@
+# Ignore build output
+.build
+dist
+coverage
+
+# Node
+node_modules
+
+# Dependency lockfiles (if you don't want Prettier to format them)
+package-lock.json
+yarn.lock
+
+# Serverless, system, IDE, or OS files
+.serverless
+.DS_Store
+.env
+*.log
+
+# Lambdas' bundles (if any)
+bundle-*.js

package/serverless/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": true,
+  "singleQuote": false,
+  "printWidth": 100,
+  "trailingComma": "all"
+}

package/serverless/README.md

@@ -0,0 +1,36 @@
+# Serverless Typescript Boilerplate
+
+Minimalist project template to jump start a Serverless application in TypeScript.
+
+## Keys features
+
+The current Serverless Starter Kit adds a light layer on top of the Serverless framework with modern JavaScript tools:
+
+- **TypeScript** Support.
+- **Offline** mode
+- Formatting with Prettier to enforce a consistent code style.
+
+## Services
+
+Currently, the boilerplate is built and tested on AWS using the following services.
+
+- AWS Lambda
+
+## Quick start
+
+```
+npm install
+npm run offline
+```
+
+### Deployment
+
+Make sure you have AWS Cli configured
+
+```bash
+npm run deploy
+```
+
+## Serverless plugins
+
+- [serverless-offline](https://github.com/dherault/serverless-offline): run your services offline for e.g. testing

package/serverless/docker-compose.yml

@@ -0,0 +1,36 @@
+version: "3.8"
+services:
+  dynamodb-local:
+    image: amazon/dynamodb-local
+    container_name: dynamodb-local
+    restart: unless-stopped
+    ports:
+      - "8000:8000"
+    command: "-jar DynamoDBLocal.jar -inMemory -sharedDb"
+    working_dir: /home/dynamodblocal
+    volumes:
+      - dynamodb_data:/home/dynamodblocal/data
+    environment:
+      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID:-dummy}
+      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY:-dummy}
+      - AWS_REGION=${AWS_REGION:-eu-west-2}
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8000/"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+
+  dynamodb-admin:
+    image: aaronshaf/dynamodb-admin
+    ports:
+      - "8001:8001"
+    environment:
+      - DYNAMO_ENDPOINT=${DYNAMO_ENDPOINT:-http://dynamodb-local:8000}
+      - AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID:-dummy}
+      - AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY:-dummy}
+      - AWS_REGION=${AWS_REGION:-eu-west-2}
+    links:
+      - dynamodb-local
+
+volumes:
+  dynamodb_data: