raahul-fastify-basic 1.0.0

package/README.md

@@ -0,0 +1,80 @@
+# create-fastify-basic
+
+A command-line tool to quickly generate a production-ready Fastify boilerplate with TypeScript, MongoDB (Mongoose), Socket.io, and Redis integration.
+
+## Features
+
+- **Fastify v5**: Modern, fast, and low-overhead web framework.
+- **TypeScript**: Full TypeScript support out of the box.
+- **Database Support**: MongoDB integration using Mongoose.
+- **WebSockets**: Realtime communication setup using Socket.io and Redis adapter.
+- **Structure**: Clean folder structure dividing modules, plugins, controllers, and services.
+- **Development Friendly**: Auto-reloads on code changes using nodemon.
+
+## Quick Start
+
+You can generate a starter project instantly using `npx`:
+
+```bash
+npx create-fastify-basic my-fastify-service
+```
+
+Alternatively, you can install the package globally:
+
+```bash
+npm install -g create-fastify-basic
+create-fastify-basic my-fastify-service
+```
+
+## Running the Generated App
+
+1. **Navigate to the directory**:
+   ```bash
+   cd my-fastify-service
+   ```
+
+2. **Configure your environment**:
+   Copy `.env` and fill in your details:
+   - Database URI (MongoDB)
+   - Redis connection details
+   - Port settings
+
+3. **Run in development mode**:
+   ```bash
+   npm run dev
+   ```
+
+4. **Build for production**:
+   ```bash
+   npm run build
+   ```
+
+5. **Start production server**:
+   ```bash
+   npm start
+   ```
+
+## Folder Structure
+
+```text
+├── src
+│   ├── api          # Router and endpoints
+│   ├── config       # App configurations (database, environment)
+│   ├── core         # Core utilities or constants
+│   ├── infra        # Database and external infrastructure initializers
+│   ├── lib          # Third-party service integrations
+│   ├── modules      # Modular components / domain logic
+│   ├── plugins      # Fastify plugins
+│   ├── services     # Application services (e.g. Email, Socket)
+│   ├── types        # TypeScript definitions
+│   ├── utils        # Utility functions
+│   └── index.ts     # Application entrypoint
+├── scripts          # Helper setup/deployment scripts
+├── nodemon.json     # Nodemon config for development auto-reloads
+├── tsconfig.json    # TypeScript compiler options
+└── package.json     # Node.js manifest
+```
+
+## License
+
+ISC

package/bin/cli.js

@@ -0,0 +1,129 @@
+#!/usr/bin/env node
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import readline from 'readline';
+import { execSync } from 'child_process';
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const colors = {
+  reset: '\x1b[0m',
+  bright: '\x1b[1m',
+  green: '\x1b[32m',
+  cyan: '\x1b[36m',
+  yellow: '\x1b[33m',
+  red: '\x1b[31m',
+  gray: '\x1b[90m'
+};
+function logSuccess(msg) {
+  console.log(`${colors.green}✔${colors.reset} ${msg}`);
+}
+function logInfo(msg) {
+  console.log(`${colors.cyan}ℹ${colors.reset} ${msg}`);
+}
+function logWarn(msg) {
+  console.log(`${colors.yellow}⚠${colors.reset} ${msg}`);
+}
+function logError(msg) {
+  console.error(`${colors.red}✖${colors.reset} ${msg}`);
+}
+async function askQuestion(query) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  return new Promise((resolve) => rl.question(query, (ans) => {
+    rl.close();
+    resolve(ans.trim());
+  }));
+}
+async function main() {
+  console.log(`\n${colors.bright}${colors.cyan}=== Fastify Starter App Generator ===${colors.reset}\n`);
+  let targetDir = process.argv[2];
+  if (!targetDir) {
+    targetDir = await askQuestion(`${colors.bright}Enter project directory name:${colors.reset} `);
+  }
+  if (!targetDir) {
+    logError('Project directory name is required.');
+    process.exit(1);
+  }
+  const projectPath = path.resolve(process.cwd(), targetDir);
+  const projectName = path.basename(projectPath);
+  if (fs.existsSync(projectPath)) {
+    const files = fs.readdirSync(projectPath);
+    if (files.length > 0) {
+      logWarn(`Directory ${colors.bright}${targetDir}${colors.reset} already exists and is not empty.`);
+      const answer = await askQuestion('Do you want to overwrite it? (y/N): ');
+      if (answer.toLowerCase() !== 'y' && answer.toLowerCase() !== 'yes') {
+        logInfo('Aborting installation.');
+        process.exit(0);
+      }
+    }
+  } else {
+    fs.mkdirSync(projectPath, { recursive: true });
+  }
+  const templateDir = path.resolve(__dirname, '../templates/basic');
+  if (!fs.existsSync(templateDir)) {
+    logError(`Template directory not found at ${templateDir}`);
+    process.exit(1);
+  }
+  logInfo(`Creating project in ${colors.bright}${projectPath}${colors.reset}...`);
+  function copyRecursive(src, dest) {
+    const stats = fs.statSync(src);
+    if (stats.isDirectory()) {
+      if (!fs.existsSync(dest)) {
+        fs.mkdirSync(dest, { recursive: true });
+      }
+      fs.readdirSync(src).forEach((child) => {
+        if (child === 'node_modules') return;
+        copyRecursive(path.join(src, child), path.join(dest, child));
+      });
+    } else {
+      const filename = path.basename(src);
+      if (filename === '_gitignore') {
+        fs.copyFileSync(src, path.join(path.dirname(dest), '.gitignore'));
+      } else {
+        fs.copyFileSync(src, dest);
+      }
+    }
+  }
+  try {
+    copyRecursive(templateDir, projectPath);
+    logSuccess('Template files copied.');
+    const packageJsonPath = path.join(projectPath, 'package.json');
+    if (fs.existsSync(packageJsonPath)) {
+      const pkg = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+      pkg.name = projectName;
+      pkg.description = `Fastify service app generated using create-fastify-basic`;
+      fs.writeFileSync(packageJsonPath, JSON.stringify(pkg, null, 2), 'utf8');
+      logSuccess('Updated package.json configuration.');
+    }
+    const runInstall = await askQuestion(`\nDo you want to run ${colors.cyan}npm install${colors.reset} now? (Y/n): `);
+    if (runInstall.toLowerCase() === 'y' || runInstall.toLowerCase() === 'yes' || runInstall === '') {
+      logInfo('Installing dependencies (this may take a minute)...');
+      try {
+        execSync('npm install', { cwd: projectPath, stdio: 'inherit' });
+        logSuccess('Dependencies installed successfully.');
+      } catch (err) {
+        logError('Failed to install dependencies. Please run npm install manually.');
+      }
+    }
+    console.log(`\n${colors.green}Success! Created ${projectName} at ${projectPath}${colors.reset}\n`);
+    console.log('Inside that directory, you can run several commands:');
+    console.log(`  ${colors.cyan}npm run dev${colors.reset}`);
+    console.log('    Starts the development server.\n');
+    console.log(`  ${colors.cyan}npm run build${colors.reset}`);
+    console.log('    Builds the app for production.\n');
+    console.log(`  ${colors.cyan}npm start${colors.reset}`);
+    console.log('    Runs the built app in production mode.\n');
+    console.log('We suggest that you begin by typing:');
+    console.log(`  ${colors.cyan}cd${colors.reset} ${targetDir}`);
+    console.log(`  ${colors.cyan}npm run dev${colors.reset}`);
+    console.log('\nHappy coding!\n');
+  } catch (error) {
+    logError(`An error occurred: ${error.message}`);
+    process.exit(1);
+  }
+}
+
+main();

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "raahul-fastify-basic",
+  "version": "1.0.0",
+  "description": "CLI tool to generate a starter Fastify service application with MongoDB, Socket.io, and TypeScript.",
+  "main": "bin/cli.js",
+  "type": "module",
+  "bin": {
+    "raahul-fastify-basic": "bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "templates"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "fastify",
+    "typescript",
+    "mongodb",
+    "mongoose",
+    "socket.io",
+    "boilerplate",
+    "starter",
+    "generator",
+    "cli"
+  ],
+  "author": "Raahul Mehta",
+  "license": "ISC"
+}

package/templates/basic/.env

@@ -0,0 +1,7 @@
+MODE=MODE
+PORT=PORT
+ALLOWED_ORIGINS=ALLOWED_ORIGINS
+MONGOS_CONNECTION_STR=MONGOS_CONNECTION_STR
+JWT_SECRET=JWT_SECRET
+REDIS_URL=REDIS_URL
+NGROK_AUTH_TOKEN=NGROK_AUTH_TOKEN

package/templates/basic/_gitignore

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+.env
+*.log
+.DS_Store

package/templates/basic/nodemon.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["src"],
+  "ext": "ts,json",
+  "ignore": ["src/**/*.spec.ts", "dist"],
+  "exec": "tsx src/index.ts"
+}