create-rykira-app 1.0.0 → 1.0.2

package/bin/cli.js

@@ -1,149 +1,213 @@
-#!/usr/bin/env node
-
-import { Command } from 'commander';
-import inquirer from 'inquirer';
-import fs from 'fs-extra';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import chalk from 'chalk';
-import ora from 'ora';
-import Handlebars from 'handlebars';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const program = new Command();
-
-program
-  .name('create-rykira-app')
-  .description('Scaffold a new Rykira Starter Package project')
-  .version('1.0.0')
-  .argument('[project-directory]', 'Directory to create the project in')
-  .action(async (projectDirectory) => {
-    console.log(chalk.bold.blue('🚀 Welcome to Rykira Starter App Generator!'));
-
-    let targetDir = projectDirectory;
-
-    if (!targetDir) {
-      const answers = await inquirer.prompt([
-        {
-          type: 'input',
-          name: 'projectName',
-          message: 'What is the name of your project?',
-          default: 'my-rykira-app',
-          validate: (input) => {
-            if (/^([a-z0-9\-\_\.]+)$/.test(input)) return true;
-            return 'Project name may only include lower-case letters, numbers, dashes, underscores, and dots.';
-          },
-        },
-      ]);
-      targetDir = answers.projectName;
-    }
-
-    const rootDir = path.resolve(process.cwd(), targetDir);
-
-    if (fs.existsSync(rootDir)) {
-      console.error(chalk.red(`Error: Directory ${targetDir} already exists.`));
-      process.exit(1);
-    }
-
-    const promptAnswers = await inquirer.prompt([
-      {
-        type: 'input',
-        name: 'description',
-        message: 'Project description:',
-        default: 'A modern full-stack application',
-      },
-      {
-        type: 'input',
-        name: 'author',
-        message: 'Author name:',
-        default: 'Rykira User',
-      },
-      {
-        type: 'confirm',
-        name: 'includeAdmin',
-        message: 'Include Admin Panel?',
-        default: true,
-      },
-      {
-        type: 'confirm',
-        name: 'includeApi',
-        message: 'Include Express API?',
-        default: true,
-      },
-    ]);
-
-    const spinner = ora(`Creating project in ${chalk.green(rootDir)}...`).start();
-
-    try {
-      // Copy template files
-      const templateDir = path.resolve(__dirname, '../template');
-      await fs.copy(templateDir, rootDir, {
-        filter: (src) => {
-          // Avoid copying node_modules
-          return !src.includes('node_modules');
-        }
-      });
-
-      // Process Handlebars templates
-      const packageJsonPath = path.join(rootDir, 'package.json');
-      const packageJsonContent = await fs.readFile(packageJsonPath, 'utf-8');
-      const template = Handlebars.compile(packageJsonContent);
-      const result = template({
-        projectName: path.basename(rootDir),
-        projectDescription: promptAnswers.description,
-        authorName: promptAnswers.author,
-      });
-      await fs.writeFile(packageJsonPath, result);
-
-      // Handle Admin Panel removal
-      if (!promptAnswers.includeAdmin) {
-        spinner.text = 'Removing Admin Panel...';
-        await fs.remove(path.join(rootDir, 'apps/admin'));
-        await fs.remove(path.join(rootDir, 'infrastructure/docker/Dockerfile.admin'));
-        // Note: You might need to clean up pnpm-workspace.yaml or turbo.json if strict
-      }
-
-      // Handle API removal
-      if (!promptAnswers.includeApi) {
-        spinner.text = 'Removing Express API...';
-        await fs.remove(path.join(rootDir, 'apps/api'));
-        await fs.remove(path.join(rootDir, 'infrastructure/docker/Dockerfile.api'));
-      }
-      
-      // Update Compose files with project name
-      const composeProdPath = path.join(rootDir, 'infrastructure/docker/compose.prod.yml');
-      const composeDevPath = path.join(rootDir, 'infrastructure/docker/compose.dev.yml');
-      
-      const updateComposeFile = async (filePath) => {
-          if (fs.existsSync(filePath)) {
-              const content = await fs.readFile(filePath, 'utf-8');
-              const composeTemplate = Handlebars.compile(content);
-              const composeResult = composeTemplate({
-                  projectName: path.basename(rootDir)
-              });
-              await fs.writeFile(filePath, composeResult);
-          }
-      };
-
-      await updateComposeFile(composeProdPath);
-      await updateComposeFile(composeDevPath);
-
-
-      spinner.succeed(chalk.green('Project created successfully!'));
-      
-      console.log('\nNext steps:');
-      console.log(chalk.cyan(`  cd ${targetDir}`));
-      console.log(chalk.cyan('  pnpm install'));
-      console.log(chalk.cyan('  cp .env.example .env'));
-      console.log(chalk.cyan('  pnpm dev'));
-
-    } catch (error) {
-      spinner.fail(chalk.red('Failed to create project'));
-      console.error(error);
-      process.exit(1);
-    }
-  });
-
-program.parse(process.argv);
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import inquirer from 'inquirer';
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import chalk from 'chalk';
+import ora from 'ora';
+import Handlebars from 'handlebars';
+import { createRequire } from 'module';
+
+const require = createRequire(import.meta.url);
+const pkg = require('../package.json');
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const program = new Command();
+
+program
+  .name('create-rykira-app')
+  .description('Scaffold a new Rykira Starter Package project')
+  .version(pkg.version)
+  .argument('[project-directory]', 'Directory to create the project in')
+  .action(async (projectDirectory) => {
+    console.log(chalk.bold.blue('🚀 Welcome to Rykira Starter App Generator!'));
+
+    let targetDir = projectDirectory;
+
+    if (!targetDir) {
+      const answers = await inquirer.prompt([
+        {
+          type: 'input',
+          name: 'projectName',
+          message: 'What is the name of your project?',
+          default: 'my-rykira-app',
+          validate: (input) => {
+            if (/^([a-z0-9\-\_\.]+)$/.test(input)) return true;
+            return 'Project name may only include lower-case letters, numbers, dashes, underscores, and dots.';
+          },
+        },
+      ]);
+      targetDir = answers.projectName;
+    }
+
+    const rootDir = path.resolve(process.cwd(), targetDir);
+
+    if (fs.existsSync(rootDir)) {
+      console.error(chalk.red(`Error: Directory ${targetDir} already exists.`));
+      process.exit(1);
+    }
+
+    const promptAnswers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'description',
+        message: 'Project description:',
+        default: 'A modern full-stack application',
+      },
+      {
+        type: 'input',
+        name: 'author',
+        message: 'Author name:',
+        default: 'Rykira User',
+      },
+      {
+        type: 'confirm',
+        name: 'includeAdmin',
+        message: 'Include Admin Panel?',
+        default: true,
+      },
+      {
+        type: 'confirm',
+        name: 'includeApi',
+        message: 'Include Express API?',
+        default: true,
+      },
+      {
+        type: 'list',
+        name: 'deploymentStrategy',
+        message: 'Choose your deployment strategy:',
+        choices: [
+          { name: 'Automated CI/CD (GitHub Actions + GHCR)', value: 'cicd' },
+          { name: 'Coolify (Self-Hosted PaaS)', value: 'coolify' },
+          { name: 'Direct Source Build (Simple)', value: 'direct' }
+        ],
+        default: 'cicd'
+      },
+      {
+        type: 'input',
+        name: 'githubUsername',
+        message: 'GitHub Username (required for GHCR image tagging):',
+        when: (answers) => answers.deploymentStrategy === 'cicd',
+        validate: (input) => input.length > 0 ? true : 'GitHub username is required for CI/CD setup'
+      }
+    ]);
+
+    const spinner = ora(`Creating project in ${chalk.green(rootDir)}...`).start();
+
+    try {
+      // Copy template files
+      const templateDir = path.resolve(__dirname, '../template');
+      await fs.copy(templateDir, rootDir, {
+        filter: (src) => {
+          // Avoid copying node_modules and build artifacts
+          if (src.includes('node_modules')) return false;
+          
+          const basename = path.basename(src);
+          return !['.next', '.turbo', 'dist', 'coverage', 'build', '.DS_Store'].includes(basename);
+        }
+      });
+
+      // Process Handlebars templates for package.json
+      const packageJsonPath = path.join(rootDir, 'package.json');
+      const packageJsonContent = await fs.readFile(packageJsonPath, 'utf-8');
+      const template = Handlebars.compile(packageJsonContent);
+      const result = template({
+        projectName: path.basename(rootDir),
+        projectDescription: promptAnswers.description,
+        authorName: promptAnswers.author,
+      });
+      await fs.writeFile(packageJsonPath, result);
+
+      // Handle Admin Panel removal
+      if (!promptAnswers.includeAdmin) {
+        spinner.text = 'Removing Admin Panel...';
+        await fs.remove(path.join(rootDir, 'apps/admin'));
+        await fs.remove(path.join(rootDir, 'infrastructure/docker/Dockerfile.admin'));
+        // Note: You might need to clean up pnpm-workspace.yaml or turbo.json if strict
+      }
+
+      // Handle API removal
+      if (!promptAnswers.includeApi) {
+        spinner.text = 'Removing Express API...';
+        await fs.remove(path.join(rootDir, 'apps/api'));
+        await fs.remove(path.join(rootDir, 'infrastructure/docker/Dockerfile.api'));
+      }
+      
+      // Deployment Variables
+      const isCicd = promptAnswers.deploymentStrategy === 'cicd';
+      const isCoolify = promptAnswers.deploymentStrategy === 'coolify';
+      const isDirect = promptAnswers.deploymentStrategy === 'direct';
+
+      // Update Compose files with project name and deployment logic
+      const composeProdPath = path.join(rootDir, 'infrastructure/docker/compose.prod.yml');
+      const composeDevPath = path.join(rootDir, 'infrastructure/docker/compose.dev.yml');
+      
+      const updateFileWithContext = async (filePath) => {
+          if (fs.existsSync(filePath)) {
+              const content = await fs.readFile(filePath, 'utf-8');
+              const compiledTemplate = Handlebars.compile(content);
+              const compiledResult = compiledTemplate({
+                  projectName: path.basename(rootDir),
+                  githubUsername: promptAnswers.githubUsername,
+                  isCicd,
+                  isCoolify,
+                  isDirect,
+                  includeAdmin: promptAnswers.includeAdmin,
+                  includeApi: promptAnswers.includeApi,
+                  deploymentStrategy: promptAnswers.deploymentStrategy
+              });
+              await fs.writeFile(filePath, compiledResult);
+          }
+      };
+
+      await updateFileWithContext(composeProdPath);
+      await updateFileWithContext(composeDevPath);
+
+      // Update Deploy Script
+      const deployScriptPath = path.join(rootDir, 'infrastructure/scripts/deploy.sh');
+      await updateFileWithContext(deployScriptPath);
+
+      // Update README.md
+      const readmePath = path.join(rootDir, 'README.md');
+      await updateFileWithContext(readmePath);
+
+      // Cleanup
+      if (!isCicd) {
+          // Remove CI/CD workflows if not using CI/CD
+          // Note: If you want to keep CI (tests) for other modes, you might want to split the file or keep a basic one.
+          // For now, removing the specific ci-cd pipeline.
+          await fs.remove(path.join(rootDir, '.github/workflows/ci-cd.yml'));
+      }
+
+      spinner.succeed(chalk.green('Project created successfully!'));
+      
+      console.log('\nNext steps:');
+      console.log(chalk.cyan(`  cd ${targetDir}`));
+      console.log(chalk.cyan('  pnpm install'));
+      console.log(chalk.cyan('  cp .env.example .env'));
+      console.log(chalk.cyan('  pnpm dev'));
+      
+      if (isCicd) {
+        console.log(chalk.yellow('\nCI/CD Setup:'));
+        console.log('  1. Create a repository on GitHub');
+        console.log('  2. Add secrets: HOST, USERNAME, SSH_KEY');
+        console.log('  3. Push to main to trigger deployment');
+      } else if (isDirect) {
+        console.log(chalk.yellow('\nDeployment:'));
+        console.log('  1. Setup your server using infrastructure/scripts/setup-server.sh');
+        console.log('  2. Configure .env with DEPLOY_HOST details');
+        console.log('  3. Run: npm run deploy');
+      }
+
+    } catch (error) {
+      spinner.fail(chalk.red('Failed to create project'));
+      console.error(error);
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rykira-app",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "CLI to scaffold Rykira Starter Package",
   "bin": {
     "create-rykira-app": "./bin/cli.js"

package/template/.github/workflows/ci-cd.yml

@@ -0,0 +1,97 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  test:
+    name: Build, Lint, and Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 2
+      
+      - uses: pnpm/action-setup@v3
+        with:
+          version: 9
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+
+      - name: Lint
+        run: pnpm lint
+
+      - name: Typecheck
+        run: pnpm typecheck
+
+  build-and-push:
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        service: [web, admin, api]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}-${{ matrix.service }}
+          tags: |
+            type=raw,value=latest
+            type=sha,prefix=
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: infrastructure/docker/Dockerfile.${{ matrix.service }}
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  deploy:
+    needs: build-and-push
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    steps:
+      - name: Deploy to VPS
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.SSH_KEY }}
+          script: |
+            cd ~/app || exit
+            # Pull latest images
+            docker compose -f infrastructure/docker/compose.prod.yml pull
+            # Restart containers
+            docker compose -f infrastructure/docker/compose.prod.yml up -d

package/template/README.md

@@ -1,21 +1,72 @@
-# shadcn/ui monorepo template
-
-This is a Next.js monorepo template with shadcn/ui.
-
-## Adding components
-
-To add components to your app, run the following command at the root of your `web` app:
-
-```bash
-pnpm dlx shadcn@latest add button -c apps/web
-```
-
-This will place the ui components in the `packages/ui/src/components` directory.
-
-## Using components
-
-To use the components in your app, import them from the `ui` package.
-
-```tsx
-import { Button } from "@workspace/ui/components/button";
-```
+# {{projectName}}
+
+This is a Next.js monorepo template with shadcn/ui.
+
+## Getting Started
+
+1. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+
+2. Start the development server:
+   ```bash
+   pnpm dev
+   ```
+
+## Deployment
+
+**Selected Strategy:** {{deploymentStrategy}}
+
+To deploy your application:
+
+```bash
+pnpm run deploy
+```
+
+{{#if isCicd}}
+### Automated CI/CD Setup
+1. Push this repository to GitHub.
+2. Go to Settings > Secrets and Variables > Actions.
+3. Add the following secrets:
+   - `HOST`: Your server IP address.
+   - `USERNAME`: Your server SSH username (e.g., `root`).
+   - `SSH_KEY`: Your private SSH key.
+4. Push to `main` to trigger deployment.
+{{/if}}
+
+{{#if isDirect}}
+### Direct Source Build Setup
+1. SSH into your server.
+2. Run the setup script:
+   ```bash
+   curl -sL https://raw.githubusercontent.com/user/repo/main/infrastructure/scripts/setup-server.sh | bash
+   ```
+3. Configure your `.env` file with `DEPLOY_HOST` and `DEPLOY_USER`.
+4. Run `pnpm run deploy` from your local machine.
+{{/if}}
+
+{{#if isCoolify}}
+### Coolify Setup
+1. Create a project in your Coolify dashboard.
+2. Connect this Git repository.
+3. Coolify will automatically detect the configuration and build your application.
+{{/if}}
+
+## Adding components
+
+To add components to your app, run the following command at the root of your `web` app:
+
+```bash
+pnpm dlx shadcn@latest add button -c apps/web
+```
+
+This will place the ui components in the `packages/ui/src/components` directory.
+
+## Using components
+
+To use the components in your app, import them from the `ui` package.
+
+```tsx
+import { Button } from "@workspace/ui/components/button";
+```

package/template/infrastructure/docker/Dockerfile.admin

@@ -23,7 +23,7 @@ COPY --from=pruner /app/out/full/ .
 RUN pnpm turbo build --filter=admin
 
 
-FROM node:20-alpine AS runner
+FROM base AS runner
 
 WORKDIR /app
 

package/template/infrastructure/docker/Dockerfile.api

@@ -23,7 +23,7 @@ COPY --from=pruner /app/out/full/ .
 RUN pnpm turbo build --filter=api
 
 
-FROM node:20-alpine AS runner
+FROM base AS runner
 
 WORKDIR /app
 

package/template/infrastructure/docker/Dockerfile.web

@@ -35,7 +35,7 @@ RUN pnpm turbo build --filter=web
 # 3️⃣ RUN APPLICATION
 # -----------------------------
 
-FROM node:20-alpine AS runner
+FROM base AS runner
 
 WORKDIR /app
 

package/template/infrastructure/docker/compose.dev.yml

@@ -19,6 +19,7 @@ services:
     build:
       context: ../..
       dockerfile: infrastructure/docker/Dockerfile.web
+    container_name: {{projectName}}-web-dev
     env_file:
       - ../../.env
     ports:
@@ -36,6 +37,7 @@ services:
 
   postgres:
     image: postgres:16
+    container_name: {{projectName}}-postgres-dev
     environment:
       POSTGRES_DB: ${POSTGRES_DB}
       POSTGRES_USER: ${POSTGRES_USER}