@ifecodes/backend-template 1.1.1 → 1.1.5

package/bin/lib/prompts.js

@@ -59,19 +59,19 @@ export const getProjectConfig = async () => {
       initial: 0,
     },
     {
-      type: isInMicroserviceProject || hasCliArgs || isCI ? null : "text",
+      type: isInMicroserviceProject || isCI ? null : "text",
       name: "description",
       message: pc.cyan("Project description") + pc.dim(" (optional)"),
       initial: "",
     },
     {
-      type: isInMicroserviceProject || hasCliArgs || isCI ? null : "text",
+      type: isInMicroserviceProject || isCI ? null : "text",
       name: "author",
       message: pc.cyan("Author") + pc.dim(" (optional)"),
       initial: "",
     },
     {
-      type: isInMicroserviceProject || hasCliArgs || isCI ? null : "text",
+      type: isInMicroserviceProject || isCI ? null : "text",
       name: "keywords",
       message: pc.cyan("Keywords") + pc.dim(" (comma-separated, optional)"),
       initial: "",
@@ -86,12 +86,16 @@ export const getProjectConfig = async () => {
       ],
     },
     {
-      type: (prev, values) =>
-        isInMicroserviceProject || isCI
-          ? null
-          : prev === "microservice"
-          ? "select"
-          : null,
+      type: (prev, values) => {
+        // Skip if in existing microservice project or CI mode
+        if (isInMicroserviceProject || isCI) return null;
+        
+        // Get projectType from previous answers or CLI args
+        const projectType = prev || cliProjectType || values.projectType;
+        
+        // Show prompt only if projectType is microservice
+        return projectType === "microservice" ? "select" : null;
+      },
       name: "mode",
       message: pc.cyan("Microservice setup"),
       choices: [
@@ -135,13 +139,35 @@ export const getProjectConfig = async () => {
         { title: pc.blue("CORS"), value: "cors" },
       ],
     },
-  ]);
+  ],
+  {
+    onCancel: () => {
+      console.log(pc.yellow("\n❌ Operation cancelled by user."));
+      process.exit(0);
+    }
+  });
 
   // Handle cancelled prompts (user pressed Ctrl+C or closed the prompt)
-  if (!res || !res.name) {
+  // Check if user cancelled the prompt (Ctrl+C) vs just didn't enter anything
+  if (!res) {
     console.log(pc.yellow("\n❌ Operation cancelled by user."));
     process.exit(0);
   }
+  
+  // Check if critical fields are missing (indicates cancellation mid-prompt)
+  if (!isInMicroserviceProject && !isCI) {
+    // For new projects, we need language and projectType
+    if (!res.language || (!res.projectType && !cliProjectType)) {
+      console.log(pc.yellow("\n❌ Operation cancelled by user."));
+      process.exit(0);
+    }
+  }
+  
+  // If the response is empty but we expected prompts, something went wrong
+  if (Object.keys(res).length === 0 && !isInMicroserviceProject && !hasCliArgs && !isCI) {
+    console.log(pc.red("\n❌ No inputs received. Please try again."));
+    process.exit(1);
+  }
 
   // Set defaults for CI/non-interactive mode
   if (isCI) {
@@ -161,6 +187,11 @@ export const getProjectConfig = async () => {
       res.projectType = res.projectType || "monolith";
     }
   }
+  
+  // Ensure we have a project name (fallback if somehow missed)
+  if (!res.name && !isInMicroserviceProject) {
+    res.name = "my-backend";
+  }
 
   let sanitizedName, target, isExistingProject, mode;
 

package/bin/lib/readme-generator.js

@@ -86,16 +86,16 @@ export const generateReadme = (config, serviceName = null) => {
   
   // Environment Variables
   readme += `3. Set up environment variables\n`;
-  readme += `\`\`\`bash\n`;
   if (isMicroservice) {
-    readme += `# Copy .env.example to .env in each service\n`;
-    readme += `cp services/gateway/.env.example services/gateway/.env\n`;
-    readme += `cp services/health-service/.env.example services/health-service/.env\n`;
-    if (auth) readme += `cp services/auth-service/.env.example services/auth-service/.env\n`;
+    readme += `\`\`\`bash\n`;
+    readme += `# Environment variables are configured in docker-compose.yml or pm2.config.js\n`;
+    readme += `# No .env files needed for individual services\n`;
+    readme += `\`\`\`\n\n`;
   } else {
+    readme += `\`\`\`bash\n`;
     readme += `cp .env.example .env\n`;
+    readme += `\`\`\`\n\n`;
   }
-  readme += `\`\`\`\n\n`;
   
   if (auth) {
     readme += `4. Configure your MongoDB connection and JWT secret in the \`.env\` file${isMicroservice ? "s" : ""}\n\n`;
@@ -143,24 +143,85 @@ export const generateReadme = (config, serviceName = null) => {
   
   if (isMicroservice) {
     readme += `All requests go through the API Gateway at \`http://localhost:4000\`\n\n`;
-    readme += `### Health Service\n`;
-    readme += `- **GET** \`/health\` - Health check\n\n`;
+
+    readme += `### Gateway Endpoints\n`;
+    readme += `- **GET** \`/\` - API information and available endpoints\n`;
+    readme += `- **GET** \`/health\` - Gateway health check\n`;
+
+    readme += `### Health Service (Proxied through Gateway)\n`;
+    readme += `- **GET** \`/api/v1/health\` - Service health check with system metrics\n`;
+    readme += `  - Returns: status, uptime, timestamp, memory usage\n\n`;
+
+    if (auth) {
+      readme += `### Auth Service (Proxied through Gateway)\n`;
+      readme += `- **POST** \`/api/v1/auth/register\` - Register a new user\n`;
+      readme += `- **POST** \`/api/v1/auth/login\` - Login user\n\n`;
+    }
     
+    readme += `### Direct Service Access (Development Only)\n`;
+    readme += `- **Gateway**: \`http://localhost:4000\`\n`;
+    readme += `- **Health Service**: \`http://localhost:4001/api/v1/health\`\n\n`;
+    if (auth) readme  += `- **Auth Service**: \`http://localhost:4002/api/v1/auth\`\n\n`;
+
+    readme += "### Example Requests\n";
+    readme += "```bash\n";
+    readme += "# Gateway info\n";
+    readme += "curl http://localhost:4000/\n\n";
+    readme += "# Gateway health\n";
+    readme += "curl http://localhost:4000/health\n\n";
+    readme += "# Health service (through gateway)\n";
+    readme += "curl http://localhost:4000/api/v1/health\n\n";
+    readme += "# Health service (direct access)\n";
+    readme += "curl http://localhost:4001/api/v1/health\n";
     if (auth) {
-      readme += `### Auth Service\n`;
-      readme += `- **POST** \`/auth/register\` - Register a new user\n`;
-      readme += `- **POST** \`/auth/login\` - Login user\n\n`;
+      readme += "\n# Register user (through gateway)\n";
+      readme += `curl -X POST http://localhost:4000/api/v1/auth/register \\\n`;
+      readme += `  -H "Content-Type: application/json" \\\n`;
+      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
+      readme += "# Login user (through gateway)\n";
+      readme += `curl -X POST http://localhost:4000/api/v1/auth/login \\\n`;
+      readme += `  -H "Content-Type: application/json" \\\n`;
+      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
+      readme += "# Register user (direct access)\n";
+      readme += `curl -X POST http://localhost:4002/api/v1/auth/register \\\n`;
+      readme += `  -H "Content-Type: application/json" \\\n`;
+      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
+      readme += "# Login user (direct access)\n";
+      readme += `curl -X POST http://localhost:4002/api/v1/auth/login \\\n`;
+      readme += `  -H "Content-Type: application/json" \\\n`;
+      readme += `  -d '{"username":"testuser","password":"password123"}'\n`;
     }
+    readme += "```\n\n";
+    
   } else {
     readme += `Base URL: \`http://localhost:4000\`\n\n`;
     readme += `- **GET** \`/\` - Root endpoint (API info)\n`;
-    readme += `- **GET** \`/v1/health\` - Health check\n\n`;
+    readme += `- **GET** \`/api/v1/health\` - Health check\n\n`;
     
     if (auth) {
       readme += `### Authentication\n`;
-      readme += `- **POST** \`/v1/auth/register\` - Register a new user\n`;
-      readme += `- **POST** \`/v1/auth/login\` - Login user\n\n`;
+      readme += `- **POST** \`/api/v1/auth/register\` - Register a new user\n`;
+      readme += `- **POST** \`/api/v1/auth/login\` - Login user\n\n`;
+    }
+
+    // Example requests for monolith
+    readme += "### Example Requests\n";
+    readme += "```bash\n";
+    readme += "# Root info\n";
+    readme += "curl http://localhost:4000/\n\n";
+    readme += "# Health check\n";
+    readme += "curl http://localhost:4000/api/v1/health\n\n";
+    if (auth) {
+      readme += "# Register user\n";
+      readme += `curl -X POST http://localhost:4000/api/v1/auth/register \\\n`;
+      readme += `  -H \"Content-Type: application/json\" \\\n`;
+      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
+      readme += "# Login user\n";
+      readme += `curl -X POST http://localhost:4000/api/v1/auth/login \\\n`;
+      readme += `  -H \"Content-Type: application/json\" \\\n`;
+      readme += `  -d '{"username":"testuser","password":"password123"}'\n\n`;
     }
+    readme += "```\n\n";
   }
   
   // Project Structure