create-arktos 1.5.0 → 2.0.0

package/package.json

@@ -1,35 +1,26 @@
 {
   "name": "create-arktos",
-  "version": "1.5.0",
-  "description": "🚀 A modern Node.js backend boilerplate with TypeScript, Express, JWT authentication, Prisma ORM, PostgreSQL, and Resend email service. Includes complete authentication flow, security middleware, and database management.",
-  "main": "bin/cli.js",
-  "bin": {
-    "create-arktos": "./bin/cli.js"
-  },
+  "version": "2.0.0",
+  "type": "module",
+  "description": "🚀 Production-ready Node.js & TypeScript backend boilerplate generator with Express, JWT, Prisma ORM, PostgreSQL (Neon), and Resend",
+  "license": "BSL-1.1",
   "files": [
-    "bin/",
-    "src/",
-    "prisma/",
-    "template.package.json",
-    ".env.example",
-    "vercel.json",
-    "tsconfig.json",
-    "eslint.config.js",
+    "index.js",
+    "cli",
+    "templates",
     "README.md",
     "LICENSE"
   ],
-  "scripts": {
-    "build": "tsc",
-    "start": "node bin/cli.js",
-    "dev": "ts-node --esm bin/cli.js",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint . --ext .ts,.js",
-    "lint:fix": "eslint . --ext .ts,.js --fix",
-    "format": "prettier --write .",
-    "format:check": "prettier --check .",
-    "typecheck": "tsc --noEmit",
-    "prepublishOnly": "echo 'Publishing arktos CLI tool...'",
-    "clean": "rm -rf dist"
+  "bin": {
+    "create-arktos": "./index.js"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "author": {
+    "name": "Zafer Gök",
+    "email": "gok.zaferr@gmail.com",
+    "url": "https://github.com/zzafergok"
   },
   "keywords": [
     "nodejs",
@@ -56,16 +47,6 @@
     "starter",
     "scaffold"
   ],
-  "author": {
-    "name": "Zafer Gök",
-    "email": "gok.zaferr@gmail.com",
-    "url": "https://github.com/zzafergok"
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=18.0.0",
-    "npm": ">=8.0.0"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zzafergok/arktos.git"
@@ -74,10 +55,6 @@
     "url": "https://github.com/zzafergok/arktos/issues"
   },
   "homepage": "https://github.com/zzafergok/arktos#readme",
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/zzafergok"
-  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
@@ -85,24 +62,20 @@
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^12.0.0",
-    "inquirer": "^10.0.0",
+    "fs-extra": "^11.2.0",
     "ora": "^8.0.1",
-    "fs-extra": "^11.2.0"
+    "prompts": "^2.4.2"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
-    "@types/inquirer": "^9.0.7",
     "@types/node": "^22.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.0.0",
-    "@typescript-eslint/parser": "^8.0.0",
-    "eslint": "^9.0.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.0",
-    "prettier": "^3.3.0",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.5.0"
+    "@types/prompts": "^2.4.9"
   },
-  "peerDependencies": {
-    "typescript": ">=4.7.0"
+  "scripts": {
+    "start": "node index.js",
+    "build": "node -e 'process.exit(0)'",
+    "type-check": "node -e 'process.exit(0)'",
+    "pack:check": "node scripts/check-tarball-size.mjs",
+    "test:smoke": "node scripts/smoke-test-template.mjs"
   }
-}
+}

package/templates/backend/.prettierrc

@@ -0,0 +1,23 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "bracketSameLine": false,
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "quoteProps": "as-needed",
+  "jsxSingleQuote": true,
+  "overrides": [
+    {
+      "files": "*.json",
+      "options": {
+        "tabWidth": 2
+      }
+    }
+  ]
+}
+EOF < /dev/null

package/templates/backend/LICENSE

@@ -0,0 +1,34 @@
+Business Source License 1.1
+
+Parameters:
+
+Licensor:               Zafer Gök
+Licensed Work:          Arktos, including the create-arktos CLI generator, backend architectures, templates, and associated documentation.
+Additional Use Grant:   You may use the Licensed Work free of charge for non-commercial, evaluation, educational, internal development, and testing purposes. Any production deployment, commercial offering, commercial client deliverables, or providing the Licensed Work (or modified versions thereof) as a paid backend service or competing product requires a separate commercial license agreement with the Licensor.
+Change Date:            2030-01-01
+Change License:         Apache License, Version 2.0 (or at your option, MIT License)
+
+Notice:
+
+The Business Source License 1.1 (the "License") is not an Open Source license.
+However, the Licensor pledges to grant an Open Source license on the Change Date.
+
+Text of the License:
+
+1. Grant of License.
+Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-commercial use of the Licensed Work, subject to the Additional Use Grant and other conditions set forth herein.
+
+2. Additional Use Grant.
+As specified in the Parameters above, you are permitted to use the Licensed Work free of charge exclusively under the conditions defined in the Additional Use Grant. Use of the Licensed Work outside the Additional Use Grant without obtaining a commercial license from the Licensor is strictly prohibited.
+
+3. Commercial Inquiries.
+To obtain a commercial license for production, commercial, or enterprise use, contact the Licensor at gok.zaferr@gmail.com or visit https://github.com/zzafergok/arktos.
+
+4. Change Date and Change License.
+Effective on the Change Date specified in the Parameters above, the Licensor hereby grants you a license to the Licensed Work under the Change License specified in the Parameters above, without the restrictions of this License.
+
+5. Attribution and Notice.
+You must retain all copyright notices, trademarks, and this License notice in all copies or substantial portions of the Licensed Work.
+
+6. Disclaimer of Warranties.
+THE LICENSED WORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE LICENSOR OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE LICENSED WORK OR THE USE OR OTHER DEALINGS IN THE LICENSED WORK.

package/bin/cli.js

@@ -1,332 +0,0 @@
-#!/usr/bin/env node
-
-const fs = require('fs');
-const path = require('path');
-const { execSync } = require('child_process');
-
-const TEMPLATE_DIR = path.join(__dirname, '../src');
-const ROOT_DIR = path.join(__dirname, '..');
-
-function createProject(projectName) {
-  console.log(`🚀 Creating Arktos project: ${projectName}`);
-  console.log();
-
-  // Validate project name
-  if (!projectName || !/^[a-zA-Z0-9-_]+$/.test(projectName)) {
-    console.error('❌ Invalid project name. Use only letters, numbers, hyphens, and underscores.');
-    process.exit(1);
-  }
-
-  // Check if directory already exists
-  if (fs.existsSync(projectName)) {
-    console.error(`❌ Directory '${projectName}' already exists.`);
-    process.exit(1);
-  }
-
-  // Always use TypeScript template
-  const packageTemplate = 'template.package.json';
-
-  try {
-    // Create project directory
-    console.log('📁 Creating project directory...');
-    fs.mkdirSync(projectName);
-
-    // Copy src directory
-    console.log('📋 Copying TypeScript source files...');
-    const targetSrcDir = path.join(projectName, 'src');
-    copyDir(TEMPLATE_DIR, targetSrcDir);
-
-    // Copy prisma directory
-    console.log('🗄️  Copying database schema...');
-    const prismaDir = path.join(ROOT_DIR, 'prisma');
-    const targetPrismaDir = path.join(projectName, 'prisma');
-    if (fs.existsSync(prismaDir)) {
-      copyDir(prismaDir, targetPrismaDir);
-    }
-
-    // Copy template config files
-    console.log('📝 Copying configuration files...');
-    copyTemplateFiles(projectName);
-
-    // Copy and update package.json
-    console.log('🔧 Updating project configuration...');
-    const templatePackageJsonPath = path.join(ROOT_DIR, packageTemplate);
-    const targetPackageJsonPath = path.join(projectName, 'package.json');
-    
-    if (fs.existsSync(templatePackageJsonPath)) {
-      const packageJson = JSON.parse(fs.readFileSync(templatePackageJsonPath, 'utf8'));
-      
-      // Update project name
-      packageJson.name = projectName;
-      
-      fs.writeFileSync(targetPackageJsonPath, JSON.stringify(packageJson, null, 2));
-    }
-
-
-    console.log('✅ Project created successfully!');
-    console.log();
-    console.log('🎯 Next steps:');
-    console.log(`   cd ${projectName}`);
-    console.log('   npm install');
-    console.log('   cp .env.example .env');
-    console.log('   # Edit .env with your database and API keys');
-    console.log('   npx prisma migrate dev');
-    console.log('   npm run dev');
-    console.log();
-    console.log('📚 Documentation:');
-    console.log('   • Backend API: http://localhost:3001');
-    console.log('   • Setup your Neon database: https://neon.tech');
-    console.log('   • Setup Resend for emails: https://resend.com');
-    console.log('   • Deploy on Vercel: https://vercel.com');
-    console.log();
-    console.log('🔧 Available commands:');
-    console.log('   npm run dev      - Start development server');
-    console.log('   npm run build    - Build for production');
-    console.log('   npm run start    - Start production server');
-    console.log('   npm run db:studio - Open Prisma Studio');
-    console.log();
-    console.log('Happy coding! 🎉');
-
-  } catch (error) {
-    console.error('❌ Error creating project:', error.message);
-    
-    // Cleanup on error
-    try {
-      if (fs.existsSync(projectName)) {
-        fs.rmSync(projectName, { recursive: true, force: true });
-      }
-    } catch (cleanupError) {
-      console.error('❌ Error during cleanup:', cleanupError.message);
-    }
-    
-    process.exit(1);
-  }
-}
-
-function copyDir(src, dest) {
-  // Create destination directory
-  if (!fs.existsSync(dest)) {
-    fs.mkdirSync(dest, { recursive: true });
-  }
-
-  // Read source directory
-  const entries = fs.readdirSync(src, { withFileTypes: true });
-
-  for (const entry of entries) {
-    const srcPath = path.join(src, entry.name);
-    const destPath = path.join(dest, entry.name);
-
-    if (entry.isDirectory()) {
-      // Recursively copy subdirectories
-      copyDir(srcPath, destPath);
-    } else {
-      // Copy files
-      fs.copyFileSync(srcPath, destPath);
-    }
-  }
-}
-
-function copyTemplateFiles(dest) {
-  // Create common config files
-  const configFiles = {
-    '.gitignore': `# Dependencies
-node_modules/
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# Environment variables
-.env
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-# Build outputs
-dist/
-build/
-
-# Logs
-logs/
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Coverage directory used by tools like istanbul
-coverage/
-
-# OS generated files
-.DS_Store
-.DS_Store?
-._*
-.Spotlight-V100
-.Trashes
-ehthumbs.db
-Thumbs.db
-
-# IDE files
-.vscode/
-.idea/
-*.swp
-*.swo
-*~
-
-# Prisma
-prisma/migrations/dev.db*
-
-# Temporary files
-*.tmp
-*.temp
-.cache/
-
-# Vercel
-.vercel
-
-# TypeScript
-*.tsbuildinfo`,
-    '.prettierrc': `{
-  "semi": true,
-  "trailingComma": "es5",
-  "singleQuote": true,
-  "printWidth": 80,
-  "tabWidth": 2,
-  "useTabs": false,
-  "bracketSpacing": true,
-  "arrowParens": "avoid",
-  "endOfLine": "lf"
-}`,
-    'README.md': `# ${path.basename(dest)} API
-
-A modern Node.js backend API built with Arktos boilerplate.
-
-## 🚀 Features
-
-- **TypeScript**: Full TypeScript support with strict type checking
-- **Express.js**: Fast, unopinionated web framework
-- **Authentication**: Complete JWT-based authentication system
-- **Database**: Prisma ORM with PostgreSQL (Neon serverless)
-- **Email Service**: Resend integration for transactional emails
-- **Security**: Helmet, CORS, rate limiting, and security middleware
-- **Validation**: Zod-based request validation
-- **Logging**: Winston logger with file rotation
-- **Error Handling**: Comprehensive error handling and responses
-- **API Documentation**: Structured API responses
-- **Deployment Ready**: Vercel configuration included
-
-## 📋 Prerequisites
-
-- Node.js 18+ and npm 8+
-- PostgreSQL database (recommend [Neon](https://neon.tech/) for serverless)
-- Resend account for email service
-
-## 🛠️ Installation
-
-1. **Install dependencies**
-   \`\`\`bash
-   npm install
-   \`\`\`
-
-2. **Environment Setup**
-   \`\`\`bash
-   cp .env.example .env
-   \`\`\`
-   Fill in your environment variables in \`.env\`
-
-3. **Database Setup**
-   \`\`\`bash
-   # Generate Prisma client
-   npx prisma generate
-   
-   # Run database migrations
-   npx prisma migrate dev
-   \`\`\`
-
-4. **Start Development Server**
-   \`\`\`bash
-   npm run dev
-   \`\`\`
-
-## 🔧 Available Scripts
-
-- \`npm run dev\` - Start development server with hot reload
-- \`npm run build\` - Build for production
-- \`npm start\` - Start production server
-- \`npm run type-check\` - Run TypeScript type checking
-- \`npm run lint\` - Run ESLint
-- \`npm run db:studio\` - Open Prisma Studio
-
-Happy coding! 🎉`
-  };
-
-  // Write config files
-  for (const [fileName, content] of Object.entries(configFiles)) {
-    fs.writeFileSync(path.join(dest, fileName), content);
-  }
-
-  // Copy template files from root
-  const templateFiles = ['.env.example', 'vercel.json', 'tsconfig.json', 'eslint.config.js'];
-  
-  for (const templateFile of templateFiles) {
-    const srcPath = path.join(ROOT_DIR, templateFile);
-    const destPath = path.join(dest, templateFile);
-    
-    if (fs.existsSync(srcPath)) {
-      fs.copyFileSync(srcPath, destPath);
-    }
-  }
-
-}
-
-function showHelp() {
-  console.log();
-  console.log('🏛️  Arktos - Modern Node.js Backend Boilerplate');
-  console.log();
-  console.log('Usage:');
-  console.log('  npx create-arktos <project-name>');
-  console.log();
-  console.log('Example:');
-  console.log('  npx create-arktos my-awesome-api');
-  console.log();
-  console.log('Features:');
-  console.log('  ✅ Express.js server with modern middleware');
-  console.log('  ✅ JWT authentication with refresh tokens');
-  console.log('  ✅ Prisma ORM with PostgreSQL (Neon)');
-  console.log('  ✅ Email service with Resend');
-  console.log('  ✅ User authentication and management');
-  console.log('  ✅ Login logging and security features');
-  console.log('  ✅ Rate limiting and security headers');
-  console.log('  ✅ Comprehensive error handling');
-  console.log('  ✅ Winston logging');
-  console.log('  ✅ ESLint and Prettier configuration');
-  console.log('  ✅ Vercel deployment ready');
-  console.log();
-  console.log('Options:');
-  console.log('  -h, --help     Show this help message');
-  console.log('  -v, --version  Show version');
-  console.log();
-}
-
-function showVersion() {
-  const packageJson = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json'), 'utf8'));
-  console.log(packageJson.version);
-}
-
-// Main CLI logic
-const args = process.argv.slice(2);
-
-if (args.length === 0 || args[0] === '-h' || args[0] === '--help') {
-  showHelp();
-  process.exit(0);
-}
-
-if (args[0] === '-v' || args[0] === '--version') {
-  showVersion();
-  process.exit(0);
-}
-
-const projectName = args[0];
-createProject(projectName);