fix: cli no creates Dockerfile and .dockerignore for easier deployment

Author: ivictbor

adminforth/commands/createApp/templates/.dockerignore.hbs

@@ -0,0 +1,4 @@
+node_modules
+{{#if sqliteFile}}
+{{ sqliteFile }}
+{{/if}}

adminforth/commands/createApp/templates/.env.prod.hbs

@@ -0,0 +1,6 @@
+NODE_ENV=production
+DATABASE_URL=sqlite://.db.sqlite
+DATABASE_URL={{dbUrl}}
+{{#if prismaDbUrl}}
+PRISMA_DATABASE_URL={{prismaDbUrl}}
+{{/if}}

adminforth/commands/createApp/templates/Dockerfile.hbs

@@ -0,0 +1,7 @@
+FROM node:{{nodeMajor}}-slim
+WORKDIR /code/
+ADD package.json package-lock.json /code/
+RUN npm ci  
+ADD . /code/
+RUN --mount=type=cache,target=/tmp npx adminforth bundle
+CMD ["sh", "-c", "npm run migrate:prod && npm run prod"]

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

@@ -60,9 +60,9 @@ if (import.meta.url === `file://${process.argv[1]}`) {
   app.use(express.json());
 
   const port = 3500;
-
+  
   await admin.bundleNow({ hotReload: process.env.NODE_ENV === 'development' });
-  console.log('Bundling AdminForth done. For faster serving consider calling bundleNow() from a build script.');
+  console.log('Bundling AdminForth SPA done.');
 
   admin.express.serve(app)
 

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

@@ -8,11 +8,14 @@
   "license": "ISC",
   "description": "",
   "scripts": {
-    "env": "dotenvx run -f .env.local -f .env --overload --",
-    "start": "npm run env -- tsx watch index.ts",
-    "migrateLocal": "npm run env -- npx prisma migrate deploy",
-    "makemigration": "npm run migrateLocal; npm run env -- npx --yes prisma migrate dev",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "dev": "npm run _env:dev -- tsx watch index.ts",
+    "prod": "npm run _env:prod -- tsx index.ts",
+    "start": "npm run dev",
+    "makemigration": "npm run _env:dev -- npx --yes prisma migrate dev --create-only",
+    "migrate:local": "npm run _env:dev -- npx --yes prisma migrate deploy",
+    "migrate:prod": "npm run _env:prod -- npx --yes prisma migrate deploy",
+    "_env:dev": "dotenvx run -f .env -f .env.local --",
+    "_env:prod": "dotenvx run -f .env.prod --"
   },
   "engines": {
     "node": ">=20"

adminforth/commands/createApp/templates/readme.md.hbs

@@ -9,13 +9,13 @@ npm ci
 Migrate the database:
 
 ```bash
-npm run migrateLocal
+npm run migrate:local
 ```
 
 Start the server:
 
 ```bash
-npm start
+npm run dev
 ```
 
 {{#if prismaDbUrl}}
@@ -32,6 +32,18 @@ npm run makemigration -- --name <name_of_changes>
 Your colleagues will need to pull the changes and run `npm run migrateLocal` to apply the migration in their local database.
 {{/if}}
 
+## Deployment tips
+
+You have Dockerfile ready for production deployment. You can test the build with:
+
+```bash
+docker build -t {{appName}}-image .
+docker run -p 3500:3500 {{appName}}-image
+```
+
+To set non-sensitive environment variables in production, use `.env.prod` file.
+For sensitive variables, use direct docker environment variables or secrets from your vault.
+
 ## Documentation
 
 - [Customizing AdminForth Branding](https://adminforth.dev/docs/tutorial/Customization/branding/)

adminforth/commands/createApp/utils.js

@@ -7,8 +7,12 @@ import path from 'path';
 import { Listr } from 'listr2'
 import { fileURLToPath } from 'url';
 import {ConnectionString} from 'connection-string';
-import {execa} from 'execa';
+import { exec } from 'child_process';
+
 import Handlebars from 'handlebars';
+import { promisify } from 'util';
+
+const execAsync = promisify(exec);
 
 export function parseArgumentsIntoOptions(rawArgs) {
   const args = arg(
@@ -145,18 +149,19 @@ async function scaffoldProject(ctx, options, cwd) {
   await fse.copy(sourceAssetsDir, targetAssetsDir);
 
   // Write templated files
-  writeTemplateFiles(dirname, projectDir, {
+  await writeTemplateFiles(dirname, projectDir, {
     dbUrl: connectionString.toString(),
     prismaDbUrl,
     appName,
     provider,
+    nodeMajor: parseInt(process.versions.node.split('.')[0], 10),
   });
 
   return projectDir;  // Return the new directory path
 }
 
 async function writeTemplateFiles(dirname, cwd, options) {
-  const { dbUrl, prismaDbUrl, appName, provider } = options;
+  const { dbUrl, prismaDbUrl, appName, provider, nodeMajor } = options;
 
   // Build a list of files to generate
   const templateTasks = [
@@ -191,10 +196,15 @@ async function writeTemplateFiles(dirname, cwd, options) {
       dest: '.env.local',
       data: { dbUrl, prismaDbUrl },
     },
+    {
+      src: '.env.prod.hbs',
+      dest: '.env.prod',
+      data: { dbUrl, prismaDbUrl },
+    },
     {
       src: 'readme.md.hbs',
       dest: 'README.md',
-      data: { dbUrl, prismaDbUrl },
+      data: { dbUrl, prismaDbUrl, appName },
     },
     {
       // We'll write .env using the same content as .env.sample
@@ -218,6 +228,18 @@ async function writeTemplateFiles(dirname, cwd, options) {
       dest: 'custom/tsconfig.json',
       data: {},
     },
+    {
+      src: 'Dockerfile.hbs',
+      dest: 'Dockerfile',
+      data: { nodeMajor },
+    },
+    {
+      src: '.dockerignore.hbs',
+      dest: '.dockerignore',
+      data: {
+        sqliteFile: detectDbProvider(options.db).startsWith('sqlite') ? options.db.split('://')[1] : null,
+      },
+    }
   ];
 
   for (const task of templateTasks) {
@@ -228,38 +250,41 @@ async function writeTemplateFiles(dirname, cwd, options) {
     // fse.ensureDirSync(path.dirname(destPath));
 
     if (task.empty) {
-      fs.writeFileSync(destPath, '');
+      await fs.promises.writeFile(destPath, '');
     } else {
       const templatePath = path.join(dirname, 'templates', task.src);
       const compiled = renderHBSTemplate(templatePath, task.data);
-      fs.writeFileSync(destPath, compiled);
+      await fs.promises.writeFile(destPath, compiled);
     }
   }
 }
 
 async function installDependencies(ctx, cwd) {
-  const customDir = ctx.customDir;
+  const nodeBinary = process.execPath; // Path to the Node.js binary running this script
+  const npmPath = path.join(path.dirname(nodeBinary), 'npm'); // Path to the npm executable
 
-  await Promise.all([
-    await execa('npm', ['install'], { cwd }),
-    await execa('npm', ['install'], { cwd: customDir }),
+  const customDir = ctx.customDir;
+  const res = await Promise.all([
+    await execAsync(`${nodeBinary} ${npmPath} install`, { cwd, env: { PATH: process.env.PATH } }),
+    await execAsync(`${nodeBinary} ${npmPath} install`, { cwd: customDir, env: { PATH: process.env.PATH } }),
   ]);
+  // console.log(chalk.dim(`Dependencies installed in ${cwd} and ${customDir}: \n${res[0].stdout}${res[1].stdout}`));
 }
 
 function generateFinalInstructions(skipPrismaSetup, options) {
   let instruction = '⏭️  Run the following commands to get started:\n';
   if (!skipPrismaSetup)
     instruction += `
   ${chalk.dim('// Go to the project directory')}
-  ${chalk.cyan(`$ cd ${options.appName}`)}\n`;
+  ${chalk.dim('$')}${chalk.cyan(` cd ${options.appName}`)}\n`;
 
     instruction += `
   ${chalk.dim('// Generate and apply initial migration')}
-  ${chalk.cyan('$ npm run makemigration -- --name init')}\n`;
+  ${chalk.dim('$')}${chalk.cyan(' npm run makemigration -- --name init && npm run migrate:local')}\n`;
 
   instruction += `
   ${chalk.dim('// Start dev server with tsx watch for hot-reloading')}
-  ${chalk.cyan('$ npm start')}\n
+  ${chalk.dim('$')}${chalk.cyan(' npm run dev')}\n
 `;
 
   instruction += '😉 Happy coding!';

dev-demo/package.json

@@ -6,10 +6,9 @@
   "type": "module",
   "scripts": {
     "env": "dotenvx run -f .env.local -f .env --overload --",
-    "test": "echo \"Error: no test specified\" && exit 1",
     "start": "npm run env -- tsx watch index.ts",
-    "migrateLocal": "npm run env -- npx prisma migrate deploy",
-    "makemigration": "npm run migrateLocal; npm run env -- npx --yes prisma migrate dev"
+    "makemigration": "npm run _env:dev -- npx --yes prisma migrate dev --create-only",
+    "migrate:local": "npm run _env:dev -- npx --yes prisma migrate deploy"
   },
   "author": "",
   "license": "ISC",