create-xpress-backend 1.0.0

package/src/templates/shared.js

@@ -0,0 +1,283 @@
+'use strict';
+
+/**
+ * Files identical between JS and TS (or only trivially different).
+ */
+function buildSharedFiles({ projectName, port, includeFileUpload, includeAuth, language }) {
+  const isTs = language === 'ts';
+  const files = {};
+
+  // ─── .env & .env.example ──────────────────────────────────────────────────
+  const envContent = [
+    `NODE_ENV=development`,
+    `PORT=${port}`,
+    ``,
+    `# Database`,
+    `DATABASE_URL="postgresql://postgres:admin@localhost:5432/${projectName}_db"`,
+    ``,
+    `# JWT`,
+    `JWT_SECRET=your-super-secret-jwt-key-change-this`,
+    `JWT_EXPIRES_IN=7d`,
+    ``,
+    ...(includeFileUpload ? [`# File Upload`, `MAX_FILE_SIZE=10`, `UPLOAD_PATH=./uploads`, ``] : []),
+    `# Client`,
+    `CLIENT_URL=http://localhost:3000`,
+    `SERVER_URL=http://localhost:${port}`,
+  ].join('\n');
+
+  files['.env'] = envContent;
+  files['.env.example'] = envContent;
+
+  // ─── .gitignore ───────────────────────────────────────────────────────────
+  files['.gitignore'] = [
+    'node_modules',
+    '.env',
+    'dist',
+    'uploads/*',
+    '!uploads/.gitkeep',
+    '*.log',
+    '.DS_Store',
+  ].join('\n');
+
+  // ─── prisma.config (JS only — TS version is in ts.js) ────────────────────
+  if (!isTs) {
+    files['prisma.config.js'] = `const { defineConfig } = require('@prisma/config');
+require('dotenv').config();
+
+module.exports = defineConfig({
+  datasource: {
+    url: process.env.DATABASE_URL,
+  },
+});
+`;
+  }
+
+  // ─── prisma/schema.prisma ─────────────────────────────────────────────────
+  const schemaLines = [
+    `// prisma/schema.prisma`,
+    `generator client {`,
+    `  provider = "prisma-client-js"`,
+    `}`,
+    ``,
+    `datasource db {`,
+    `  provider = "postgresql"`,
+    `}`,
+    ``,
+    `model User {`,
+    `  id        String   @id @default(uuid())`,
+    `  email     String   @unique`,
+    `  name      String?`,
+    ...(includeAuth ? [`  password  String?`] : []),
+    ...(includeFileUpload ? [`  files     File[]`] : []),
+    `  createdAt DateTime @default(now())`,
+    `  updatedAt DateTime @updatedAt`,
+    `}`,
+  ];
+
+  if (includeFileUpload) {
+    schemaLines.push(
+      ``,
+      `model File {`,
+      `  id           String   @id @default(cuid())`,
+      `  filename     String`,
+      `  originalName String`,
+      `  path         String`,
+      `  size         Int`,
+      `  mimetype     String`,
+      `  userId       String`,
+      `  user         User     @relation(fields: [userId], references: [id], onDelete: Cascade)`,
+      `  createdAt    DateTime @default(now())`,
+      `  updatedAt    DateTime @updatedAt`,
+      ``,
+      `  @@map("files")`,
+      `}`
+    );
+  }
+
+  files['prisma/schema.prisma'] = schemaLines.join('\n') + '\n';
+
+  // ─── seed file ────────────────────────────────────────────────────────────
+  if (isTs) {
+    files['src/database/seed.ts'] = `// src/database/seed.ts
+import prisma from './prisma';
+
+async function main() {
+  const email = 'admin@${projectName}.com';
+  const existing = await prisma.user.findUnique({ where: { email } });
+
+  if (!existing) {
+    await prisma.user.create({ data: { email, name: 'Admin User' } });
+    console.log(\`Seed: admin user \${email} created.\`);
+  } else {
+    console.log(\`Seed: admin user \${email} already exists. Skipping.\`);
+  }
+}
+
+main()
+  .catch((e) => { console.error('Seed error:', e); process.exit(1); })
+  .finally(async () => { await prisma.$disconnect(); });
+`;
+  } else {
+    files['src/database/seed.js'] = `// src/database/seed.js
+const prisma = require('./prisma');
+
+async function main() {
+  const email = 'admin@${projectName}.com';
+  const existing = await prisma.user.findUnique({ where: { email } });
+
+  if (!existing) {
+    await prisma.user.create({ data: { email, name: 'Admin User' } });
+    console.log(\`Seed: admin user \${email} created.\`);
+  } else {
+    console.log(\`Seed: admin user \${email} already exists. Skipping.\`);
+  }
+}
+
+main()
+  .catch((e) => { console.error('Seed error:', e); process.exit(1); })
+  .finally(async () => { await prisma.$disconnect(); });
+`;
+  }
+
+  return files;
+}
+
+// ─── Per-project README builder ───────────────────────────────────────────────
+function buildReadme({ projectName, port, includeFileUpload, includeAuth, language }) {
+  const isTs = language === 'ts';
+  const ext = isTs ? 'ts' : 'js';
+  const devCmd = isTs ? 'npm run dev' : 'npm run dev';
+  const seedCmd = isTs ? 'npm run db:seed' : 'npm run db:seed';
+
+  const features = [
+    `⚡ Express 4 with security middleware (Helmet, CORS)`,
+    `🗄️  Prisma 7 ORM with PostgreSQL (driver adapter)`,
+    `✅ Joi request validation`,
+    `🌱 Database seeding script`,
+    ...(includeFileUpload ? [`📁 File upload system (Multer)`] : []),
+    ...(includeAuth ? [`🔐 JWT authentication (register / login)`] : []),
+    `🔄 Graceful shutdown`,
+    `🏥 Health check endpoint`,
+    ...(isTs ? [`🔷 Full TypeScript support with strict mode`] : []),
+  ];
+
+  const uploadRoutes = includeFileUpload
+    ? `| \`POST\`   | \`/api/demo/upload\`         | Upload a file          |
+| \`GET\`    | \`/api/demo/files/all\`     | List uploaded files    |
+| \`DELETE\` | \`/api/demo/files/:fileId\` | Delete a file          |`
+    : '';
+
+  const authRoutes = includeAuth
+    ? `\n### Auth\n\n| Method | Path | Description |\n|--------|------|-------------|\n| \`POST\` | \`/api/auth/register\` | Register a user |\n| \`POST\` | \`/api/auth/login\` | Login |\n`
+    : '';
+
+  const buildSection = isTs
+    ? `\n## Build\n\n\`\`\`bash\nnpm run build   # compiles TypeScript → dist/\nnpm start       # runs compiled output\n\`\`\`\n`
+    : '';
+
+  const tsScripts = isTs
+    ? `| \`npm run build\`      | Compile TypeScript to \`dist/\`       |
+| \`npm start\`          | Run compiled production build        |` : '';
+
+  const structureExtras = isTs
+    ? `│   ├── types/\n│   │   └── express.d.ts       ← req.user type augmentation\n` : '';
+
+  return `# ${projectName}
+
+> Scaffolded with [create-xpress-backend](https://github.com/ayushsolanki29/create-xpress-backend) · ${isTs ? 'TypeScript' : 'JavaScript'}
+
+## Stack
+
+- **Runtime** — Node.js ≥ 18
+- **Language** — ${isTs ? 'TypeScript 5 (strict mode)' : 'JavaScript (CommonJS)'}
+- **Framework** — Express 4
+- **ORM** — Prisma 7 + PostgreSQL (driver adapter)
+- **Validation** — Joi
+${includeAuth ? `- **Auth** — JWT (jsonwebtoken + bcryptjs)\n` : ''}${includeFileUpload ? `- **Uploads** — Multer\n` : ''}
+## Features
+
+${features.map((f) => `- ${f}`).join('\n')}
+
+## Quick Start
+
+\`\`\`bash
+npm install
+
+# configure DATABASE_URL in .env, then:
+npm run db:push
+${seedCmd}    # optional
+${devCmd}
+\`\`\`
+
+Server starts on **http://localhost:${port}**
+${buildSection}
+## Scripts
+
+| Command               | Description                          |
+|-----------------------|--------------------------------------|
+| \`npm run dev\`         | Start dev server with auto-reload    |
+${tsScripts ? tsScripts + '\n' : ''}| \`npm run db:push\`     | Push Prisma schema to the database   |
+| \`npm run db:generate\` | Regenerate Prisma Client             |
+| \`npm run db:dev\`      | Push schema + generate in one step   |
+| \`npm run db:seed\`     | Seed initial data                    |
+| \`npm run db:studio\`   | Open Prisma Studio                   |
+| \`npm run db:reset\`    | Force-reset the database schema      |
+
+## API Reference
+
+### Demo
+
+| Method   | Path              | Description     |
+|----------|-------------------|-----------------|
+| \`POST\`   | \`/api/demo\`      | Create a record |
+| \`GET\`    | \`/api/demo\`      | Get all records |
+| \`GET\`    | \`/api/demo/:id\`  | Get by ID       |
+| \`PUT\`    | \`/api/demo/:id\`  | Update          |
+| \`DELETE\` | \`/api/demo/:id\`  | Delete          |
+${uploadRoutes ? uploadRoutes + '\n' : ''}
+${authRoutes}
+### Health
+
+| Method | Path      | Description         |
+|--------|-----------|---------------------|
+| \`GET\`  | \`/health\` | Server health check |
+
+## Project Structure
+
+\`\`\`
+${projectName}/
+├── prisma/
+│   └── schema.prisma
+├── src/
+│   ├── app.${ext}
+│   ├── server.${ext}
+${structureExtras}│   ├── database/
+│   │   ├── prisma.${ext}
+│   │   └── seed.${ext}
+│   ├── middleware/
+│   │   ├── validate.${ext}
+${includeFileUpload ? `│   │   ├── upload.${ext}\n` : ''}${includeAuth ? `│   │   └── auth.${ext}\n` : ''}│   └── modules/
+│       ├── index.${ext}
+│       ├── demo/
+${includeAuth ? `│       └── auth/\n` : ''}${isTs ? `├── tsconfig.json\n` : ''}├── .env
+├── .env.example
+└── package.json
+\`\`\`
+
+## Environment Variables
+
+| Variable         | Description                    | Default  |
+|------------------|--------------------------------|----------|
+| \`PORT\`           | Server port                    | \`${port}\` |
+| \`DATABASE_URL\`   | PostgreSQL connection string   | —        |
+| \`JWT_SECRET\`     | Secret key for JWT signing     | —        |
+| \`JWT_EXPIRES_IN\` | Token expiry duration          | \`7d\`   |
+| \`CLIENT_URL\`     | Allowed CORS origin            | \`*\`    |
+${includeFileUpload ? `| \`MAX_FILE_SIZE\`  | Max upload size in MB          | \`10\`   |\n` : ''}
+## License
+
+MIT
+`;
+}
+
+module.exports = { buildSharedFiles, buildReadme };