create-ts-express-app 1.0.0

package/template/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "create-ts-express-kit",
+  "version": "1.1.0",
+  "main": "index.js",
+  "bin": {
+    "create-ts-express-kit": "./create.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": [],
+  "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",
+    "ncp": "^2.0.0"
+  },
+  "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/src/config/config.ts

@@ -0,0 +1,4 @@
+export const config = {
+  PORT: process.env.PORT || 5000,
+  env: process.env.NODE_ENV || 'development',
+};

package/template/src/controllers/userController.ts

@@ -0,0 +1,20 @@
+import { Request, Response } from 'express';
+import users from '../models/users.json';
+
+// Get all users
+export const getAllUsers = (req: Request, res: Response) => {
+  res.json(users);
+};
+
+// Get user by ID
+export const getUserById = (req: Request, res: Response): void => {
+  const id = parseInt(req.params.id);
+  const user = users.find((u) => u.id === id);
+
+  if (!user) {
+    res.status(404).json({ message: 'User not found' });
+return; // Ensure the function exits after sending a response
+  }
+
+  res.json(user);
+};

package/template/src/index.ts

@@ -0,0 +1,27 @@
+import express from 'express';
+import dotenv from 'dotenv';
+dotenv.config();
+import { errorHandler } from './middleware/errorHandler';
+import apiRoutes from './routes/api';
+import { config } from './config/config';
+import userRoutes from './routes/userRoutes';
+
+// Load environment variables
+const app = express();
+const PORT = config.PORT;
+// Middleware
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+
+// Routes
+app.use('/api', apiRoutes);
+app.use('/api/users', userRoutes);
+app.get('/', (req, res) => {
+  res.send('TypeScript Node.js Backend is running!');
+});
+
+app.use(errorHandler);
+// Start server
+app.listen(PORT, () => {
+  console.log(`Server running on port http://localhost:${PORT}`);
+});

package/template/src/middleware/errorHandler.ts

@@ -0,0 +1,14 @@
+import { Request, Response, NextFunction } from "express"
+
+export const errorHandler = (
+  err: Error,
+  req: Request,
+  res: Response,
+  next: NextFunction
+) => {
+  console.error(err.stack)
+  res.status(500).json({
+    success: false,
+    error: "Server Error",
+  })
+}

package/template/src/models/users.json

@@ -0,0 +1,4 @@
+[
+  { "id": 1, "name": "John Doe", "email": "john@example.com" },
+  { "id": 2, "name": "Jane Smith", "email": "jane@example.com" }
+]

package/template/src/routes/api.ts

@@ -0,0 +1,8 @@
+import express from "express"
+const router = express.Router()
+
+router.get("/test", (req, res) => {
+  res.json({ message: "API is working" })
+})
+
+export default router

package/template/src/routes/userRoutes.ts

@@ -0,0 +1,9 @@
+import { Router } from 'express';
+import { getAllUsers, getUserById } from '../controllers/userController';
+
+const router = Router();
+
+router.get('/', getAllUsers);
+router.get('/:id', getUserById);
+
+export default router;

package/template/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "strict": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"]
+}