a-a-node 1.0.0

package/README.md

@@ -0,0 +1,114 @@
+# NPM Package Workflow Guide
+
+This repository contains commonly used commands for creating, testing, and publishing an npm package.
+
+---
+
+## Initialize NPM Project
+
+```bash
+npm init
+```
+
+---
+
+## NPM Authentication
+
+### Login to NPM
+
+```bash
+npm login
+```
+
+### Logout from NPM
+
+```bash
+npm logout
+```
+
+---
+
+## Local Package Linking (For Testing)
+
+Use this to test your npm package locally before publishing.
+
+### Link Package Locally
+
+```bash
+npm link
+```
+
+### Unlink Package Locally
+
+```bash
+npm unlink -g <package-name>
+```
+
+---
+
+## Publishing NPM Package
+
+### Publish Without 2FA
+
+```bash
+npm publish --access public
+```
+
+### Standard Publish
+
+```bash
+npm publish
+```
+
+---
+
+## Update NPM Package
+
+Increase patch version and publish:
+
+```bash
+npm version patch
+npm publish --access public
+```
+
+Other version options:
+
+- `npm version minor`
+- `npm version major`
+
+---
+
+## Package Information
+
+### Check if Package Already Exists
+
+```bash
+npm view <package-name>
+```
+
+### Check Package Owner
+
+```bash
+npm owner ls <package-name>
+```
+
+---
+
+## Bypass 2FA Using NPM Token
+
+Configure npm authentication token (useful for CI/CD):
+
+```bash
+npm config set //registry.npmjs.org/:_authToken=<YOUR_NPM_TOKEN>
+```
+
+⚠️ **Important:** Never commit your npm token to source control.
+
+---
+
+## Notes
+
+- Always update the version before publishing
+- Test locally using `npm link`
+- Ensure package name is unique
+- Enable 2FA for better security

package/bin/cli.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+const { createProject } = require("../lib/index");
+
+const projectName = process.argv[2];
+
+if (!projectName) {
+  console.error("❌ Please provide a project name");
+  console.log("Usage: a-a-node <project-name>");
+  process.exit(1);
+}
+
+createProject(projectName);

package/lib/index.js

@@ -0,0 +1,107 @@
+const fs = require("fs-extra");
+const path = require("path");
+const { execSync } = require("child_process");
+const chalk = require("chalk");
+const ora = require("ora");
+const os = require("os");
+
+async function createProject(projectName) {
+  const targetPath = path.join(process.cwd(), projectName);
+  const templatePath = path.join(__dirname, "..", "template");
+
+  console.log(chalk.blue(`\n🚀 Creating project "${projectName}"...\n`));
+  console.log(
+    chalk.gray(`Platform: ${os.platform()} | Node: ${process.version}\n`),
+  );
+
+  // Check if template exists
+  if (!fs.existsSync(templatePath)) {
+    console.error(
+      chalk.red(`❌ Template directory not found at: ${templatePath}`),
+    );
+    process.exit(1);
+  }
+
+  // Check if directory already exists
+  if (fs.existsSync(targetPath)) {
+    console.error(chalk.red(`❌ Directory "${projectName}" already exists!`));
+    process.exit(1);
+  }
+
+  try {
+    // Step 1: Copy template files
+    // const copySpinner = ora("Copying template files...").start();
+    await fs.copy(templatePath, targetPath, {
+      filter: (src) => {
+        // Get the relative path from template
+        const relativePath = path.relative(templatePath, src);
+
+        // Always include the root template directory
+        if (relativePath === "") {
+          return true;
+        }
+
+        // Exclude specific files/folders
+        const excludes = ["node_modules", ".git", "dist", "build", ".env"];
+        const baseName = path.basename(src);
+
+        // Check if any exclude pattern matches
+        return !excludes.includes(baseName);
+      },
+    });
+    // copySpinner.succeed(chalk.green("Template files copied successfully!"));
+
+    // Step 2: Update package.json with project name
+    // const updateSpinner = ora("Updating package.json...").start();
+    const packageJsonPath = path.join(targetPath, "package.json");
+
+    if (fs.existsSync(packageJsonPath)) {
+      const packageJson = await fs.readJson(packageJsonPath);
+      packageJson.name = projectName;
+      await fs.writeJson(packageJsonPath, packageJson, { spaces: 2 });
+      // updateSpinner.succeed(chalk.green("package.json updated!"));
+    } else {
+      updateSpinner.warn(chalk.yellow("No package.json found in template"));
+    }
+
+    // Step 3: Create .env from .env.example if exists
+    const envExamplePath = path.join(targetPath, ".env.example");
+    const envPath = path.join(targetPath, ".env");
+
+    if (fs.existsSync(envExamplePath) && !fs.existsSync(envPath)) {
+      await fs.copy(envExamplePath, envPath);
+      // console.log(chalk.green("\n✓ .env file created from .env.example"));
+    }
+
+    // Step 4: Initialize git (optional)
+    // const gitSpinner = ora("Initializing git repository...").start();
+    // try {
+    //   execSync("git init", {
+    //     cwd: targetPath,
+    //     stdio: "ignore",
+    //   });
+    //   // gitSpinner.succeed(chalk.green("Git repository initialized!"));
+    // } catch (error) {
+    //   // gitSpinner.warn(chalk.yellow("Git not found or initialization skipped"));
+    // }
+
+    // Success message
+    console.log(chalk.green.bold("\n✨ Project created successfully!\n"));
+    // console.log(chalk.cyan("To get started, run:\n"));
+    // console.log(chalk.white(`  cd ${projectName}`));
+    // console.log(chalk.white(`  npm install`));
+    // console.log(chalk.white(`  npm run dev\n`));
+  } catch (error) {
+    console.error(chalk.red("\n❌ Error creating project:"), error.message);
+
+    // Cleanup on error
+    if (fs.existsSync(targetPath)) {
+      console.log(chalk.yellow("Cleaning up..."));
+      await fs.remove(targetPath);
+    }
+
+    process.exit(1);
+  }
+}
+
+module.exports = { createProject };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "a-a-node",
+  "version": "1.0.0",
+  "description": "CLI tool to quickly scaffold a Node.js boilerplate project",
+  "main": "lib/index.js",
+  "bin": {
+    "a-a-node": "bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "template"
+  ],
+  "scripts": {
+    "test": "echo \"No tests specified\"",
+    "postinstall": "node -e \"try{const fs=require('fs');const path=require('path');const binPath=path.join(__dirname,'bin','cli.js');if(fs.existsSync(binPath)){fs.chmodSync(binPath,0o755);}}catch(e){}\""
+  },
+  "keywords": [
+    "nodejs",
+    "boilerplate",
+    "cli",
+    "scaffold",
+    "template",
+    "typescript",
+    "express",
+    "cross-platform"
+  ],
+  "author": "Your Name",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "fs-extra": "^11.1.1",
+    "ora": "^5.4.1"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ]
+}

package/template/.github/workflows/staging.yml

@@ -0,0 +1,25 @@
+name: Deploy to staging
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types:
+      - closed
+    branches:
+      - staging
+
+jobs:
+  deploy:
+    timeout-minutes: 10
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to Staging
+        id: deploy
+        continue-on-error: true
+        uses: fifsky/ssh-action@master
+        with:
+          host: ${{ secrets.STAGING_SERVER }}
+          user: ${{ secrets.STAGING_USER }}
+          key: ${{ secrets.STAGING_PRIVATE_KEY }}
+          command: bash -i -c 'cd /home/ubuntu/Project-Backend && git checkout package-lock.json && git pull && npm i && npm run migrate && npm run build && pm2 restart all'

package/template/COMMANDS.md

@@ -0,0 +1,3 @@
+npm install bcryptjs compression cors dotenv express helmet joi jsonwebtoken mongoose socket.io multer 
+
+npm install -D typescript ts-node @types/node @types/express @types/bcryptjs @types/compression @types/cors @types/jsonwebtoken @types/mongoose @types/socket.io @types/multer nodemon  

package/template/env.md

@@ -0,0 +1,5 @@
+PORT=3000
+MONGODB_URI=mongodb://localhost:27017/sagar-pratical
+JWT_SECRET=JWT_SECRET
+JWT_EXPIRE=7d
+JWT_REFRESH_EXPIRE=7d