create-rykira-app 1.0.1 → 2.0.0

package/bin/cli.js

@@ -1,156 +1,162 @@
-#!/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,
-      },
-    ]);
-
-    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
-      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,
+      }
+    ]);
+
+    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'));
+        // 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'));
+      }
+      
+      // Deployment Variables (Forced to Coolify)
+      const isCoolify = true;
+
+      // Update Compose files with project name and deployment logic
+      const composeDevPath = path.join(rootDir, 'docker-compose.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),
+                  isCoolify,
+                  includeAdmin: promptAnswers.includeAdmin,
+                  includeApi: promptAnswers.includeApi,
+                  deploymentStrategy: 'coolify'
+              });
+              await fs.writeFile(filePath, compiledResult);
+          }
+      };
+
+      await updateFileWithContext(composeDevPath);
+
+      // Update README.md
+      const readmePath = path.join(rootDir, 'README.md');
+      await updateFileWithContext(readmePath);
+
+      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);

package/package.json

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

package/template/README.md

@@ -1,21 +1,44 @@
-# 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
+
+This project is configured to be deployed easily using [Coolify](https://coolify.io/).
+
+### Coolify Setup
+1. Create a project in your Coolify dashboard.
+2. Connect this Git repository.
+3. Add a resource for each application (`web`, `admin`, `api`).
+4. Set the Base Directory to `/` (root) for all of them.
+5. Set the respective build and start commands for each app (e.g. `pnpm install && pnpm turbo build --filter=web...` and `pnpm --filter web start`).
+
+## 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/apps/admin/nixpacks.toml

@@ -5,4 +5,4 @@ nixPkgs = ['nodejs', 'pnpm']
 cmds = ['pnpm install', 'pnpm turbo build --filter=admin...']
 
 [start]
-cmd = 'pnpm start:admin'
+cmd = 'pnpm --filter admin start'

package/template/apps/web/nixpacks.toml

@@ -5,4 +5,4 @@ nixPkgs = ['nodejs', 'pnpm']
 cmds = ['pnpm install', 'pnpm turbo build --filter=web...']
 
 [start]
-cmd = 'pnpm start:web'
+cmd = 'pnpm --filter web start'

package/template/docker-compose.yml

@@ -0,0 +1,19 @@
+version: "3.9"
+
+services:
+
+  postgres:
+    image: postgres:16
+    container_name: {{projectName}}-postgres-dev
+    environment:
+      POSTGRES_DB: ${POSTGRES_DB}
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+    ports:
+      - "5432:5432"
+
+  redis:
+    image: redis:7
+    container_name: {{projectName}}-redis-dev
+    ports:
+      - "6379:6379"

package/deployment.md

@@ -1,168 +0,0 @@
-# Deployment Guide
-
-This guide covers how to deploy the Rykira Starter Package application using Coolify (automated) or manually using Docker and Traefik on a VPS.
-
-## Table of Contents
-
-- [Prerequisites](#prerequisites)
-- [Environment Configuration](#environment-configuration)
-- [Option 1: Deploy with Coolify (Recommended)](#option-1-deploy-with-coolify-recommended)
-- [Option 2: Manual Deployment (Docker & Traefik)](#option-2-manual-deployment-docker--traefik)
-- [Post-Deployment Verification](#post-deployment-verification)
-- [Troubleshooting](#troubleshooting)
-
----
-
-## Prerequisites
-
-- **Domain Name**: A domain name pointing to your server IP (e.g., `example.com`, `*.example.com`).
-- **VPS/Server**: A server running Ubuntu 22.04/24.04 (minimum 2GB RAM, 2 vCPUs recommended).
-- **Git Repository**: Your project pushed to a Git provider (GitHub, GitLab, etc.).
-
----
-
-## Environment Configuration
-
-All deployments require a `.env` file. Use the `.env.example` as a template.
-
-### Required Variables
-
-```env
-# Domain Configuration
-DOMAIN=example.com
-ACME_EMAIL=admin@example.com
-
-# Postgres Configuration
-POSTGRES_USER=postgres
-POSTGRES_PASSWORD=secure_password_here
-POSTGRES_DB=rykira
-
-# Redis Configuration
-REDIS_PASSWORD=secure_redis_password_here
-
-# Database Connection Strings (Internal Docker Network)
-DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:5432/${POSTGRES_DB}
-REDIS_URL=redis://:${REDIS_PASSWORD}@redis:6379
-
-# App Secrets
-NEXTAUTH_SECRET=generate_a_long_random_string
-auth_secret=generate_a_long_random_string
-```
-
----
-
-## Option 1: Deploy with Coolify (Recommended)
-
-Coolify is an open-source, self-hostable Heroku alternative that makes deployment easy.
-
-### Step 1: Prepare Your Project
-1. Ensure `nixpacks.toml` files exist in `apps/web`, `apps/admin`, and `apps/api` (included in this template).
-2. Push your code to a GitHub repository.
-
-### Step 2: Configure Coolify
-1. **Create a Project** in your Coolify dashboard.
-2. **Add a Resource**: Select **Git Repository** (Private or Public).
-3. **Select Repository**: Choose your project repo.
-
-### Step 3: Add Services
-You will deploy each app as a separate resource, or use a Docker Compose stack.
-
-#### Method A: Docker Compose Stack (Easiest)
-1. In Coolify, select **Docker Compose**.
-2. Paste the contents of `infrastructure/docker/compose.prod.yml`.
-3. **IMPORTANT**: Replace `{{projectName}}` with your actual project name in the Compose file content before pasting, or ensure you set it as a variable if Coolify supports it.
-4. Go to **Environment Variables** in Coolify and add all variables from your `.env` file.
-5. Click **Deploy**.
-
-#### Method B: Individual Services (Nixpacks)
-1. **Web App (`apps/web`)**:
-   - **Build Pack**: Nixpacks
-   - **Base Directory**: `/`
-   - **Build Command**: `pnpm install && pnpm turbo build --filter=web...`
-   - **Start Command**: `pnpm start:web`
-   - **Environment Variables**: Add all required envs.
-   - **Domains**: Set to `https://app.example.com`.
-
-2. **API (`apps/api`)**:
-   - **Build Pack**: Nixpacks
-   - **Base Directory**: `/`
-   - **Build Command**: `pnpm install && pnpm turbo build --filter=api...`
-   - **Start Command**: `node apps/api/dist/index.js`
-   - **Environment Variables**: Add all required envs.
-   - **Domains**: Set to `https://api.example.com`.
-
-3. **Database & Redis**:
-   - Use Coolify's **Databases** tab to provision PostgreSQL and Redis.
-   - Update your App's `DATABASE_URL` and `REDIS_URL` to point to these internal Coolify databases.
-
----
-
-## Option 2: Manual Deployment (Docker & Traefik)
-
-This method gives you full control using standard Docker Compose and Traefik v3 as a reverse proxy.
-
-### Step 1: Server Setup
-1. SSH into your server.
-2. Clone your repository:
-   ```bash
-   git clone https://github.com/your/repo.git my-app
-   cd my-app
-   ```
-3. Run the setup script to install Docker and configure UFW firewall:
-   ```bash
-   chmod +x infrastructure/scripts/setup-server.sh
-   ./infrastructure/scripts/setup-server.sh
-   ```
-   *You may need to log out and log back in for Docker group changes to take effect.*
-
-### Step 2: Traefik Initialization
-1. Initialize the ACME JSON file for SSL certificates:
-   ```bash
-   chmod +x infrastructure/scripts/init-traefik.sh
-   ./infrastructure/scripts/init-traefik.sh
-   ```
-
-### Step 3: Deploy
-1. Create your `.env` file:
-   ```bash
-   cp .env.example .env
-   nano .env
-   # Fill in your secrets and domain
-   ```
-2. Run the deployment script:
-   ```bash
-   chmod +x infrastructure/scripts/deploy.sh
-   ./infrastructure/scripts/deploy.sh
-   ```
-
-### Step 4: Verify
-- Check running containers: `docker compose ps`
-- View logs: `docker compose logs -f`
-
----
-
-## Post-Deployment Verification
-
-1. **Check Health**:
-   - Visit `https://api.example.com/health` (should return JSON status).
-2. **Check SSL**:
-   - Visit `https://app.example.com` - ensure lock icon is present.
-3. **Database Connection**:
-   - Verify the API can read/write to the database (try logging in or creating a user).
-
----
-
-## Troubleshooting
-
-### "Acme.json permission denied"
-- Run: `chmod 600 infrastructure/traefik/acme.json`
-
-### "Gateway Timeout" (504)
-- Check if the app container is running: `docker compose ps`
-- Check logs: `docker compose logs web`
-- Ensure the port in `compose.prod.yml` matches the app's listening port (default 3000 for web, 4000 for api).
-
-### Database Connection Error
-- Ensure `DATABASE_URL` is using the container name `postgres` (not `localhost`) if running inside Docker.
-- Check if Postgres is healthy: `docker compose ps postgres`
-