Merge branch 'main' of github.com:devforth/adminforth

Author: ivictbor

.github/workflows/deploy_documentation.yaml

@@ -0,0 +1,43 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'adminforth/documentation/**'
+      - '.github/workflows/deploy_documentation.yaml'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: adminforth
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'pnpm'
+          cache-dependency-path: adminforth/pnpm-lock.yaml
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "${{ github.actor }}"
+          git config --global user.email "${{ github.actor }}@users.noreply.github.com"
+
+      - name: Install dependencies
+        run: |
+          pnpm i
+          cd documentation
+          npm ci
+
+      - name: Build and deploy docs
+        run: GIT_USER=${{ github.actor }} GIT_PASS=${{ secrets.DOCUSAURUS_DEPLOY_KEY }} pnpm rollout-doc

README.md

@@ -7,6 +7,8 @@
 
 * [Try live demo](https://demo.adminforth.dev/) 
 
+* [YouTube video: build agentic admin panel in a minutes](https://www.youtube.com/watch?v=4tB8uzY__uk)
+
 * [Hello world in 5 minutes](https://adminforth.dev/docs/tutorial/gettingStarted) with AdminForth
 
 * [Tutorial](https://adminforth.dev/docs/tutorial/Customization/branding/)
@@ -16,8 +18,10 @@
 <div align="center">
   <img src="https://github.com/user-attachments/assets/e643caad-1daa-4085-b125-cc940557a2ec"
  alt="AdminForth Dashboard" width="90%">
+
 </div>
 
+
 <br/>
 
 Why AdminForth:

adminforth/commands/callTsProxy.js

@@ -8,6 +8,27 @@ import dotenv from "dotenv";
 const currentFilePath = import.meta.url;
 const currentFileFolder = path.dirname(currentFilePath).replace("file:", "");
 
+function getLocalBinPath(currentDirectory) {
+  return path.join(currentDirectory, "node_modules", ".bin");
+}
+
+function getLocalBinExecutable(currentDirectory, command) {
+  const extension = process.platform === "win32" ? ".cmd" : "";
+  const executablePath = path.join(getLocalBinPath(currentDirectory), `${command}${extension}`);
+  return fs.existsSync(executablePath) ? executablePath : command;
+}
+
+function getEnvWithLocalBin(currentDirectory) {
+  const pathKey = process.platform === "win32" ? "Path" : "PATH";
+  const localBinPath = getLocalBinPath(currentDirectory);
+  const currentPath = process.env[pathKey] || "";
+
+  return {
+    ...process.env,
+    [pathKey]: [localBinPath, currentPath].filter(Boolean).join(path.delimiter),
+  };
+}
+
 export function callTsProxy(tsCode, silent=false) {
 
   const currentDirectory = process.cwd();
@@ -22,28 +43,37 @@ export function callTsProxy(tsCode, silent=false) {
 
   process.env.HEAVY_DEBUG && console.log("🌐 Calling tsproxy with code:", path.join(currentFileFolder, "proxy.ts"));
   return new Promise((resolve, reject) => {
-    const child = spawn("tsx", [path.join(currentFileFolder, "proxy.ts")], {
-      env: process.env,
+    const child = spawn(getLocalBinExecutable(currentDirectory, "tsx"), [path.join(currentFileFolder, "proxy.ts")], {
+      env: getEnvWithLocalBin(currentDirectory),
     });
     let stderr = "";
-    let stdoutLogs = [];
+    let stdout = "";
 
     child.stdout.on("data", (data) => {
-      stdoutLogs.push(data.toString());
+      stdout += data.toString();
     });
 
     child.stderr.on("data", (data) => {
       stderr += data;
     });
 
+    child.on("error", (error) => {
+      reject(error);
+    });
+
     child.on("close", (code) => {
-      const tsProxyResult = stdoutLogs.find(log => log.includes('>>>>>>>'));
-      const preparedStdout = tsProxyResult.slice(tsProxyResult.indexOf('>>>>>>>') + 7, tsProxyResult.lastIndexOf('<<<<<<<'));
-      const preparedStdoutLogs = stdoutLogs.filter(log => !log.includes('>>>>>>>'));
+      const resultStart = stdout.indexOf('>>>>>>>');
+      const resultEnd = stdout.lastIndexOf('<<<<<<<');
+      if (resultStart === -1 || resultEnd === -1 || resultEnd < resultStart) {
+        reject(new Error(`Invalid JSON from tsproxy. stdout: ${stdout}, stderr: ${stderr}`));
+        return;
+      }
+      const preparedStdout = stdout.slice(resultStart + 7, resultEnd);
+      const preparedStdoutLogs = stdout.slice(0, resultStart);
       if (code === 0) {
         try {
-          for (const log of preparedStdoutLogs) {
-            console.log(log);
+          if (preparedStdoutLogs) {
+            process.stdout.write(preparedStdoutLogs);
           }
           const parsed = JSON.parse(preparedStdout);
           if (!silent) {

adminforth/commands/createApp/templates/Dockerfile.hbs

@@ -5,4 +5,5 @@ ADD package.json {{dockerAdditionalManifestFiles}} /code/
 RUN {{packageManager}} {{dockerPackageInstallSubcommand}}  
 ADD . /code/
 RUN {{packageManagerExec}} adminforth bundle
+RUN {{ packageManager }} run build
 CMD ["sh", "-c", "{{packageManagerRun}} migrate:prod && {{packageManagerRun}} prod"]

adminforth/commands/createApp/templates/index.ts.hbs

@@ -19,7 +19,7 @@ export const admin = new AdminForth({
     loginBackgroundImage: 'https://images.unsplash.com/photo-1534239697798-120952b76f2b?q=80&w=3389&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D',
     loginBackgroundPosition: '1/2',
     loginPromptHTML: async () => { 
-      const adminforthUserExists = await admin.resource("adminuser").count(Filters.EQ('email', 'adminforth')) > 0;
+      const adminforthUserExists = (await admin.resource("adminuser").count(Filters.EQ('email', 'adminforth'))) > 0;
       if (adminforthUserExists) {
         return "Please use <b>adminforth</b> as username and <b>adminforth</b> as password"
       }
@@ -55,15 +55,15 @@ export const admin = new AdminForth({
     },
   ],
   resources: [
-    usersResource
+    usersResource,
   ],
   menu: [
     { type: 'heading', label: 'SYSTEM' },
     {
       label: 'Users',
       icon: 'flowbite:user-solid',
       resourceId: 'adminuser'
-    }
+    },
   ],
 });
 
@@ -82,7 +82,7 @@ if (fileURLToPath(import.meta.url) === path.resolve(process.argv[1])) {
   admin.express.serve(app);
 
   admin.discoverDatabases().then(async () => {
-    if (await admin.resource('adminuser').count() === 0) {
+    if ((await admin.resource('adminuser').count()) === 0) {
       await admin.resource('adminuser').create({
         email: 'adminforth',
         password_hash: await AdminForth.Utils.generatePasswordHash('adminforth'),

adminforth/commands/createApp/templates/package.json.hbs

@@ -9,7 +9,8 @@
   "description": "",
   "scripts": {
     "dev": "{{packageManagerEnvDev}} tsx watch index.ts",
-    "prod": "{{packageManagerEnvProd}} tsx index.ts",
+    "build": "{{packageManagerEnvProd}} tsup index.ts --format esm --clean",
+    "prod": "{{packageManagerEnvProd}} node dist/index.js",
     "start": "{{packageManagerRun}} dev",
     {{#if includePrismaMigrations}}
     "makemigration": "{{packageManagerEnvDev}} npx --yes prisma migrate dev --create-only",
@@ -30,10 +31,12 @@
   },
   "devDependencies": {
     "typescript": "6.0.3",
+    "tsup": "^8.5.1",
     "tsx": "4.11.2",
     "@types/express": "^4.17.21",
-    "@types/node": "latest",
+    "@types/node": "latest"{{#if includePrismaMigrations}},
     "@prisma/client": "latest",
     "prisma": "^7.0.0"
+    {{/if}}
   }
-}
+}

adminforth/commands/createApp/utils.js

@@ -37,6 +37,8 @@ function detectAdminforthVersion() {
 }
 
 const adminforthVersion = detectAdminforthVersion();
+const SUPPORTED_DB_URL_SCHEMES = ['sqlite://', 'postgresql://', 'mongodb://', 'mysql://', 'clickhouse://'];
+const PRISMA_MIGRATION_DB_PROTOCOLS = ['sqlite', 'postgres', 'postgresql', 'mysql'];
 
 
 export function parseArgumentsIntoOptions(rawArgs) {
@@ -56,7 +58,6 @@ export function parseArgumentsIntoOptions(rawArgs) {
     appName: args['--app-name'],
     db: args['--db'],
     useNpm: args['--use-npm'],
-    includePrismaMigrations: args['--include-prisma-migrations'],
   };
 }
 
@@ -94,8 +95,19 @@ export async function promptForMissingOptions(options) {
     });
   }
 
-  if (!options.includePrismaMigrations) {
-    questions.push({
+  const answers = await inquirer.prompt(questions);
+  const resolvedOptions = {
+      ...options,
+      appName: options.appName || answers.appName,
+      db: options.db || answers.db,
+      useNpm: options.useNpm || answers.useNpm,
+  };
+
+  if (
+    resolvedOptions.includePrismaMigrations === undefined &&
+    isPrismaMigrationDbUrl(resolvedOptions.db)
+  ) {
+    const prismaAnswer = await inquirer.prompt([{
       type: 'select',
       name: 'includePrismaMigrations',
       message: 'Include Prisma migrations? >',
@@ -104,18 +116,13 @@ export async function promptForMissingOptions(options) {
         { name: 'No', value: false },
       ],
       default: true,
-    });
-
+    }]);
+    resolvedOptions.includePrismaMigrations = prismaAnswer.includePrismaMigrations;
+  } else {
+    resolvedOptions.includePrismaMigrations = Boolean(resolvedOptions.includePrismaMigrations);
   }
 
-  const answers = await inquirer.prompt(questions);
-  return {
-      ...options,
-      appName: options.appName || answers.appName,
-      db: options.db || answers.db,
-      useNpm: options.useNpm || answers.useNpm,
-      includePrismaMigrations: options.includePrismaMigrations || answers.includePrismaMigrations,
-  };
+  return resolvedOptions;
 }
 
 function checkNodeVersion(minRequiredVersion = 20) {
@@ -134,6 +141,15 @@ function parseConnectionString(dbUrl) {
   return new ConnectionString(dbUrl);
 }
 
+function isPrismaMigrationDbUrl(dbUrl) {
+  try {
+    const connectionString = parseConnectionString(dbUrl);
+    return PRISMA_MIGRATION_DB_PROTOCOLS.includes(connectionString.protocol);
+  } catch {
+    return false;
+  }
+}
+
 function detectDbProvider(protocol) {
   if (protocol.startsWith('sqlite')) {
     return 'sqlite';
@@ -143,25 +159,27 @@ function detectDbProvider(protocol) {
     return 'mongodb';
   } else if (protocol.startsWith('mysql')) {
     return 'mysql';
+  } else if (protocol.startsWith('clickhouse')) {
+    return 'clickhouse';
   }
 
-  const message = `Unknown database provider for ${protocol}. Only SQLite, PostgreSQL, and MongoDB are supported now.`;
+  const message = `Unknown database provider for ${protocol}. Supported database URL schemes: ${SUPPORTED_DB_URL_SCHEMES.join(', ')}.`;
   throw new Error(message);
 }
 
 function generateDbUrlForPrisma(connectionString) {
+  if (!PRISMA_MIGRATION_DB_PROTOCOLS.includes(connectionString.protocol))
+    return null;
   if (connectionString.protocol.startsWith('sqlite'))
     return `file:${connectionString.host}`;
-  if (connectionString.protocol.startsWith('mongodb'))
-    return null;
   return connectionString.toString();
 }
 
 function generateDbUrlForPrismaProd(connectionString) {
+  if (!PRISMA_MIGRATION_DB_PROTOCOLS.includes(connectionString.protocol))
+    return null;
   if (connectionString.protocol.startsWith('sqlite'))
     return `file:/code/db/${connectionString.host}`;
-  if (connectionString.protocol.startsWith('mongodb'))
-    return null;
   return connectionString.toString();
 }
 
@@ -400,7 +418,7 @@ async function writeTemplateFiles(dirname, cwd, useNpm, includePrismaMigrations,
       data: { 
         appName,
         adminforthVersion: adminforthVersion,
-        includePrismaMigrations,
+        includePrismaMigrations: Boolean(resolvedPrismaDbUrl),
       },
     },
     {
@@ -425,7 +443,7 @@ async function writeTemplateFiles(dirname, cwd, useNpm, includePrismaMigrations,
     )
   }
 
-  if (includePrismaMigrations) {
+  if (resolvedPrismaDbUrl) {
     templateTasks.push(
       {
         src: 'schema.prisma.hbs',
@@ -506,7 +524,7 @@ function generateFinalInstructionsPnpm(skipPrismaSetup, options) {
   ${chalk.dim('// Go to the project directory')}
   ${chalk.dim('$')}${chalk.cyan(` cd ${options.appName}`)}\n`;
 
-  if (options.includePrismaMigrations)
+  if (options.includePrismaMigrations && !skipPrismaSetup)
     instruction += `
   ${chalk.dim('// Generate and apply initial migration')}
   ${chalk.dim('$')}${chalk.cyan(' pnpm makemigration --name init && pnpm migrate:local')}\n`;
@@ -528,7 +546,7 @@ function generateFinalInstructionsNpm(skipPrismaSetup, options) {
   ${chalk.dim('// Go to the project directory')}
   ${chalk.dim('$')}${chalk.cyan(` cd ${options.appName}`)}\n`;
 
-  if (options.includePrismaMigrations)
+  if (options.includePrismaMigrations && !skipPrismaSetup)
     instruction += `
   ${chalk.dim('// Generate and apply initial migration')}
   ${chalk.dim('$')}${chalk.cyan(' npm run makemigration -- --name init && npm run migrate:local')}\n`;