create-ts-express-app 1.0.0

package/Readme.md

@@ -0,0 +1,97 @@
+# TypeScript Node.js Backend Template
+
+A clean, production-ready TypeScript backend template for Node.js applications with modern best practices.
+
+## Features
+
+- ✅ TypeScript configuration optimized for backend development
+- ✅ Express.js web server
+- ✅ Environment variable management with dotenv
+- ✅ Development mode with hot reloading
+- ✅ Proper project structure for scalability
+- ✅ Error handling middleware
+- ✅ NPM scripts for development and production
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js 18.x or higher
+- npm or yarn
+
+### Installation
+
+1. Clone this repository:
+
+```bash
+git clone https://github.com/harsh-dev0/ts-express.git
+cd ts-express
+```
+
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Create a `.env` file in the root directory:
+
+```
+PORT=3000
+```
+
+### Development
+
+Start the development server with hot reloading:
+
+```bash
+npm run dev
+```
+
+For watching file changes:
+
+```bash
+npm run dev:watch
+```
+
+### Production
+
+Build the project:
+
+```bash
+npm run build
+```
+
+Start the production server:
+
+```bash
+npm start
+```
+
+## Project Structure
+
+```
+ts-express/
+├── src/                  # Source code
+│   ├── index.ts          # Application entry point
+│   ├── routes/           # API routes
+│   ├── controllers/      # Route controllers
+│   ├── models/           # Data models
+│   ├── middleware/       # Express middleware
+│   └── config/           # Configuration files
+├── dist/                 # Compiled output (generated)
+├── tsconfig.json         # TypeScript configuration
+├── package.json          # Project dependencies
+└── .env                  # Environment variables
+```
+
+## Scripts
+
+- `npm run build` - Compiles TypeScript to JavaScript
+- `npm start` - Starts the production server
+- `npm run dev` - Starts the development server
+- `npm run dev:watch` - Starts the development server with file watching
+
+## License
+
+MIT

package/bin/cli.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+
+const fs = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+
+// Get project name from command line
+const projectName = process.argv[2] || 'ts-express-app';
+
+// Target directory
+const targetDir = path.join(process.cwd(), projectName);
+
+// Source template directory
+const templateDir = path.join(__dirname, '..', 'templates');
+
+async function createProject() {
+  console.log(chalk.blue(`Creating a new TypeScript Express project in ${targetDir}`));
+  
+  // Check if directory exists
+  if (fs.existsSync(targetDir)) {
+    console.error(chalk.red(`Error: Directory ${projectName} already exists.`));
+    process.exit(1);
+  }
+  
+  // Copy template files
+  try {
+    await fs.copy(templateDir, targetDir);
+    console.log(chalk.green('Template files copied successfully.'));
+    
+    // Update package.json with project name
+    const packageJsonPath = path.join(targetDir, 'package.json');
+    const packageJson = await fs.readJson(packageJsonPath);
+    packageJson.name = projectName;
+    await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 });
+    
+    console.log(chalk.green('Project created successfully!'));
+    console.log(chalk.blue('\nNext steps:'));
+    console.log(`  cd ${projectName}`);
+    console.log('  npm install');
+    console.log('  npm run dev');
+  } catch (err) {
+    console.error(chalk.red(`Error creating project: ${err.message}`));
+    process.exit(1);
+  }
+}
+
+createProject();

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "create-ts-express-app",
+  "version": "1.0.0",
+  "main": "index.js",
+  "bin": {
+    "create-ts-express-app": "bin/cli.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "nodemon --exec ts-node src/index.ts",
+    "dev:watch": "nodemon --watch 'src/**/*.ts' --exec 'ts-node' src/index.ts"
+  },
+  "keywords": ["typescript", "express", "template", "starter"],
+  "author": "Harsh Pal",
+  "license": "MIT",
+  "description": "A simple backend starter for ts",
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "@typescript-eslint/eslint-plugin": "^8.30.1",
+    "@typescript-eslint/parser": "^8.30.1",
+    "eslint": "^9.24.0",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-prettier": "^5.2.6",
+    "nodemon": "^3.1.9",
+    "prettier": "^3.5.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@types/express": "^5.0.1",
+    "dotenv": "^16.5.0",
+    "express": "^5.1.0",
+    "fs": "^0.0.1-security",
+    "ncp": "^2.0.0",
+    "path": "^0.12.7"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/harsh-dev0/ts-express.git"
+  },
+  "bugs": {
+    "url": "https://github.com/harsh-dev0/ts-express/issues"
+  },
+  "homepage": "https://github.com/harsh-dev0/ts-express#readme"
+}

package/template/.env.example

@@ -0,0 +1 @@
+PORT=3000

package/template/.eslintrc.js

@@ -0,0 +1,12 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint", "prettier"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+  ],
+  rules: {
+    "prettier/prettier": "error",
+  },
+}

package/template/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2
+}

package/template/Readme.md

@@ -0,0 +1,97 @@
+# TypeScript Node.js Backend Template
+
+A clean, production-ready TypeScript backend template for Node.js applications with modern best practices.
+
+## Features
+
+- ✅ TypeScript configuration optimized for backend development
+- ✅ Express.js web server
+- ✅ Environment variable management with dotenv
+- ✅ Development mode with hot reloading
+- ✅ Proper project structure for scalability
+- ✅ Error handling middleware
+- ✅ NPM scripts for development and production
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js 18.x or higher
+- npm or yarn
+
+### Installation
+
+1. Clone this repository:
+
+```bash
+git clone https://github.com/harsh-dev0/ts-express.git
+cd ts-express
+```
+
+2. Install dependencies:
+
+```bash
+npm install
+```
+
+3. Create a `.env` file in the root directory:
+
+```
+PORT=3000
+```
+
+### Development
+
+Start the development server with hot reloading:
+
+```bash
+npm run dev
+```
+
+For watching file changes:
+
+```bash
+npm run dev:watch
+```
+
+### Production
+
+Build the project:
+
+```bash
+npm run build
+```
+
+Start the production server:
+
+```bash
+npm start
+```
+
+## Project Structure
+
+```
+ts-express/
+├── src/                  # Source code
+│   ├── index.ts          # Application entry point
+│   ├── routes/           # API routes
+│   ├── controllers/      # Route controllers
+│   ├── models/           # Data models
+│   ├── middleware/       # Express middleware
+│   └── config/           # Configuration files
+├── dist/                 # Compiled output (generated)
+├── tsconfig.json         # TypeScript configuration
+├── package.json          # Project dependencies
+└── .env                  # Environment variables
+```
+
+## Scripts
+
+- `npm run build` - Compiles TypeScript to JavaScript
+- `npm start` - Starts the production server
+- `npm run dev` - Starts the development server
+- `npm run dev:watch` - Starts the development server with file watching
+
+## License
+
+MIT