create-nextjs-cms 0.5.8

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 create-nextjs-cms
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE 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
+AUTHORS 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 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# Create Nextjs CMS
+
+The best and official way to create a nextjs-cms project with all the necessary configuration and dependencies.
+
+## Installation
+
+You can create a new cms project interactively by running:
+
+```bash
+npx create-nextjs-cms
+# or
+yarn create nextjs-cms
+# or
+pnpm create nextjs-cms
+# or
+bun create nextjs-cms
+```
+
+## Project Structure
+
+After running `create-nextjs-cms`, you'll have a fully configured nextjs-cms project with:
+
+- ✅ Next.js application setup
+- ✅ CMS configuration files
+- ✅ Database configuration
+- ✅ TypeScript configuration
+- ✅ All necessary dependencies
+- ✅ Example sections and fields
+- ✅ Development scripts
+
+## Next Steps
+
+After creating your project:
+
+```bash
+cd my-cms-app
+pnpm dev 
+```
+
+Then visit `http://localhost:3000` to see your CMS in action!
+
+## Requirements
+
+- Node.js 18+ 
+- A package manager (pnpm, npm, yarn, or bun)
+
+## Troubleshooting
+
+### Directory already exists
+
+If you try to create a project in a directory that already exists, you'll get an error. Either:
+- Choose a different directory name
+- Use `.` to create in the current directory (must be empty)
+
+### Installation fails
+
+If automatic dependency installation fails, you can manually install:
+
+```bash
+cd my-cms-app
+pnpm install 
+```
+
+### Template not found
+
+If you see an error about the template directory not being found, ensure you're using the published version of the package from npm, not a local development version.
+
+
+## License
+
+MIT License - see LICENSE file for details.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js

@@ -0,0 +1,395 @@
+#!/usr/bin/env node
+import fs from 'fs-extra';
+import { execSync } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+import path, { dirname, resolve, relative, basename } from 'node:path';
+import { Command } from 'commander';
+import prompts from 'prompts';
+import { expandHome, isValidPkgName, isEmptyDir, detectPackageManager, validateTemplate } from './lib/utils.js';
+import { readFileSync } from 'node:fs';
+import chalk from 'chalk';
+/** Resolve __dirname for ESM */
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+const packageJson = JSON.parse(readFileSync(path.join(__dirname, '../package.json'), 'utf-8'));
+/**
+ * Your build outputs to: dist/index.js
+ * Template is published at: templates/default/
+ * So at runtime we need ../templates/default from dist/index.js.
+ */
+const templateDir = fileURLToPath(new URL('../templates/default/', import.meta.url));
+const handleSigTerm = () => process.exit(0);
+process.on('SIGINT', handleSigTerm);
+process.on('SIGTERM', handleSigTerm);
+const onPromptState = (state) => {
+    if (state.aborted) {
+        // If we don't re-enable the terminal cursor before exiting
+        // the program, the cursor will remain hidden
+        process.stdout.write('\x1B[?25h');
+        process.stdout.write('\n');
+        process.exit(1);
+    }
+};
+/**
+ * Creates a blog section file in the sections folder
+ */
+async function createBlogSection(targetDir) {
+    const sectionsDir = path.join(targetDir, 'sections');
+    const blogSectionPath = path.join(sectionsDir, 'blog.section.ts');
+    // Ensure sections directory exists
+    await fs.ensureDir(sectionsDir);
+    const blogSectionContent = `import { dateField, photoField, richTextField, textField } from 'nextjs-cms/core/fields'
+import { hasItemsSection } from 'nextjs-cms/core/sections'
+
+const title = textField({
+    name: 'title',
+    label: 'Title',
+    required: true,
+    order: 1,
+})
+
+const slug = textField({
+    name: 'slug',
+    label: 'Slug',
+    required: false,
+    order: 2,
+})
+
+const coverPhotoField = photoField({
+    name: 'coverphoto',
+    label: 'Cover Photo',
+    watermark: false,
+    required: true,
+    order: 3,
+    size: {
+        width: 1200,
+        height: 628,
+        crop: true,
+    },
+    thumbnail: {
+        width: 400,
+        height: 209,
+        crop: true,
+        quality: 80,
+    },
+    type: ['jpg', 'jpeg', 'png', 'webp'],
+})
+
+const excerpt = textField({
+    name: 'excerpt',
+    label: 'Excerpt',
+    required: false,
+    order: 4,
+})
+
+const content = richTextField({
+    name: 'content',
+    label: 'Content',
+    required: true,
+    order: 5,
+    allowMedia: true,
+    allowImageUploads: {
+        publicURLPrefix: '/photos',
+    },
+})
+
+const publishedAt = dateField({
+    name: 'published_at',
+    label: 'Published At',
+    required: false,
+    order: 6,
+})
+
+const metaDescription = textField({
+    name: 'meta_description',
+    label: 'Meta Description',
+    required: false,
+    order: 7,
+})
+
+const metaKeywords = textField({
+    name: 'meta_keywords',
+    label: 'Meta Keywords',
+    required: false,
+    order: 8,
+})
+
+export default hasItemsSection({
+    name: 'blog',
+    order: 1,
+    icon: 'icon',
+    readonly: false,
+    headingField: title,
+    title: {
+        section: 'Blog',
+        singular: 'Post',
+        plural: 'Posts',
+    },
+    gallery: {
+        db: {
+            tableName: 'blog_gallery',
+            identifierField: 'reference_id',
+            photoNameField: 'photo',
+            metaField: 'meta',
+        },
+    },
+    db: {
+        table: 'blog',
+        fulltext: [
+            {
+                columns: [title],
+                name: 'title_fulltext',
+            },
+            {
+                columns: [content],
+                name: 'content_fulltext',
+            },
+        ],
+        unique: [
+            {
+                columns: [slug],
+                name: 'slug_unique',
+            },
+        ],
+        index: [
+            {
+                columns: [publishedAt],
+                name: 'published_at_index',
+            },
+        ],
+    },
+    search: {
+        searchFields: [title, content],
+    },
+    coverPhotoField: coverPhotoField,
+    generateQR: false,
+    fields: [title, slug, coverPhotoField, excerpt, content, publishedAt, metaDescription, metaKeywords],
+})
+`;
+    await fs.writeFile(blogSectionPath, blogSectionContent, 'utf-8');
+    console.log('✅ Blog section created successfully!');
+}
+async function createNextjsCms() {
+    console.log('🚀 Welcome to NextJS CMS!');
+    console.log('Creating your new CMS project...\n');
+    let projectPath = '';
+    const program = new Command(packageJson.name)
+        .version(packageJson.version, '-v, --version', 'Output the current version of create-nextjs-cms.')
+        .argument('[directory]')
+        .usage('[directory] [options]')
+        .helpOption('-h, --help', 'Display this help message.')
+        .action((name) => {
+        // Commander does not implicitly support negated options. When they are used
+        // by the user they will be interpreted as the positional argument (name) in
+        // the action handler.
+        if (name && typeof name === 'string' && !name.startsWith('--no-')) {
+            projectPath = name;
+        }
+    })
+        .allowUnknownOption()
+        .parse(process.argv);
+    const options = {
+        targetDir: '',
+        projectName: '',
+        templateDir: templateDir,
+        addBlogSection: false,
+    };
+    let targetIsCwd = false;
+    try {
+        // Ensure template folder is present in the published package
+        if (!(await fs.pathExists(templateDir))) {
+            console.error('❌ Template directory not found in the published package.');
+            console.error('   Make sure "templates/" is included in package.json#files and actually published.');
+            process.exit(1);
+        }
+        // Validate template structure
+        await validateTemplate(templateDir);
+        // If no directory was provided, prompt for project name
+        if (!projectPath) {
+            const res = await prompts({
+                onState: onPromptState,
+                type: 'text',
+                name: 'path',
+                message: 'What is your project named?',
+                initial: 'my-cms-app',
+                validate: (name) => {
+                    const validation = isValidPkgName(basename(resolve(name)));
+                    if (validation) {
+                        return true;
+                    }
+                    return 'Invalid project name: Project name can only contain letters, numbers, hyphens, and underscores.';
+                },
+            });
+            if (typeof res.path === 'string') {
+                projectPath = res.path.trim();
+            }
+        }
+        if (!projectPath) {
+            console.log('\nPlease specify the project directory:\n' +
+                `  ${chalk.cyan(program.name())} ${chalk.green('<project-directory>')}\n` +
+                'For example:\n' +
+                `  ${chalk.cyan(program.name())} ${chalk.green('my-cms-app')}\n\n` +
+                `Run ${chalk.cyan(`${program.name()} --help`)} to see all options.`);
+            process.exit(1);
+        }
+        // Resolve target path from the caller's CWD
+        const rawTarget = expandHome(projectPath);
+        options.targetDir = path.isAbsolute(rawTarget) ? rawTarget : resolve(process.cwd(), rawTarget);
+        // Derive package name from final path
+        options.projectName = basename(options.targetDir);
+        // Validate name
+        if (!isValidPkgName(options.projectName)) {
+            console.error(`Could not create a project called ${chalk.red(`"${options.projectName}"`)} because of npm naming restrictions:`);
+            console.error(`    ${chalk.red('*')} Project name can only contain letters, numbers, hyphens, and underscores.`);
+            process.exit(1);
+        }
+        targetIsCwd = path.normalize(options.targetDir) === path.normalize(process.cwd());
+        if (targetIsCwd) {
+            // Using current directory (e.g., ".")
+            if (!(await fs.pathExists(options.targetDir))) {
+                await fs.ensureDir(options.targetDir);
+            }
+            else if (!(await isEmptyDir(options.targetDir))) {
+                console.error('❌ Current directory is not empty. Choose an empty folder or a new directory name.');
+                console.error('   Tip: pnpm create nextjs-cms my-app');
+                process.exit(1);
+            }
+        }
+        else {
+            if (await fs.pathExists(options.targetDir)) {
+                console.error(`❌ Directory "${options.targetDir}" already exists.`);
+                process.exit(1);
+            }
+            await fs.ensureDir(options.targetDir);
+        }
+        // Ask if user wants to add blog section
+        const blogRes = await prompts({
+            onState: onPromptState,
+            type: 'toggle',
+            name: 'addBlogSection',
+            message: 'Would you like to add a default blog section config?',
+            initial: false,
+            active: 'Yes',
+            inactive: 'No',
+        });
+        if (typeof blogRes.addBlogSection === 'boolean') {
+            options.addBlogSection = Boolean(blogRes.addBlogSection);
+        }
+        console.log(`📁 Creating project in: ${options.targetDir}`);
+        // Copy template → project dir with a filter to skip build/cache artifacts
+        console.log('📁 Copying template files...');
+        await fs.copy(options.templateDir, options.targetDir, {
+            filter: (src) => {
+                const rel = relative(options.templateDir, src);
+                if (!rel || rel === '.')
+                    return true;
+                return (!rel.startsWith('node_modules') &&
+                    !rel.startsWith('.next') &&
+                    !rel.startsWith('dist') &&
+                    !rel.startsWith('.turbo') &&
+                    !rel.includes('tsconfig.tsbuildinfo'));
+            },
+            // Overwrite is safe since target is ensured empty (or new)
+            overwrite: true,
+            errorOnExist: false,
+        });
+        console.log('✅ Template copied successfully!');
+        // Create blog section if requested
+        if (options.addBlogSection) {
+            console.log('📝 Creating blog section...');
+            await createBlogSection(options.targetDir);
+        }
+        // Update package.json name (if template contains package.json)
+        const packageJsonPath = path.join(options.targetDir, 'package.json');
+        if (await fs.pathExists(packageJsonPath)) {
+            try {
+                const pkg = (await fs.readJson(packageJsonPath));
+                pkg.name = options.projectName;
+                await fs.writeJson(packageJsonPath, pkg, { spaces: 2 });
+                console.log(`📝 Updated package.json name to: ${options.projectName}`);
+            }
+            catch (e) {
+                console.warn('⚠️  Could not update package.json name automatically.');
+                console.warn(`   Error: ${e instanceof Error ? e.message : 'Unknown error'}`);
+            }
+        }
+        else {
+            console.warn('⚠️  No package.json found in template root; skipping name update.');
+        }
+        console.log('📦 Installing dependencies...');
+        process.chdir(options.targetDir);
+        const preferredPM = detectPackageManager();
+        let installed = false;
+        // Try preferred package manager first
+        try {
+            if (preferredPM === 'pnpm') {
+                execSync('pnpm install', { stdio: 'inherit' });
+                installed = true;
+                console.log('✅ Dependencies installed with pnpm!');
+            }
+            else if (preferredPM === 'yarn') {
+                execSync('yarn install', { stdio: 'inherit' });
+                installed = true;
+                console.log('✅ Dependencies installed with yarn!');
+            }
+            else if (preferredPM === 'bun') {
+                execSync('bun install', { stdio: 'inherit' });
+                installed = true;
+                console.log('✅ Dependencies installed with bun!');
+            }
+            else {
+                execSync('npm install', { stdio: 'inherit' });
+                installed = true;
+                console.log('✅ Dependencies installed with npm!');
+            }
+        }
+        catch {
+            console.error(`❌ ${preferredPM} install failed. Trying alternatives...`);
+            // Fallback to other package managers
+            const fallbacks = preferredPM === 'pnpm'
+                ? ['npm', 'yarn', 'bun']
+                : preferredPM === 'yarn'
+                    ? ['npm', 'pnpm', 'bun']
+                    : ['pnpm', 'yarn', 'bun'];
+            for (const pm of fallbacks) {
+                try {
+                    execSync(`${pm} install`, { stdio: 'inherit' });
+                    installed = true;
+                    console.log(`✅ Dependencies installed with ${pm}!`);
+                    break;
+                }
+                catch {
+                    console.error(`❌ ${pm} install failed.`);
+                }
+            }
+            if (!installed) {
+                console.error('❌ Failed to install dependencies automatically.');
+                console.error('   Please run "pnpm install", "npm install", "yarn install", or "bun install" manually.');
+            }
+        }
+        console.log('\n🎉 Your NextJS CMS project has been created successfully!');
+        console.log('\nNext steps:');
+        console.log(`  cd ${options.projectName}`);
+        console.log(installed
+            ? `  ${preferredPM} dev  # or: npm run dev`
+            : `  ${preferredPM} install && ${preferredPM} dev  # or: npm install && npm run dev`);
+        console.log('\nHappy coding! 🚀');
+    }
+    catch (error) {
+        console.error('❌ Failed to create project:', error);
+        // Clean up partial installation on error
+        if ((await fs.pathExists(options.targetDir)) && !targetIsCwd) {
+            console.log('🧹 Cleaning up partial installation...');
+            try {
+                await fs.remove(options.targetDir);
+                console.log('✅ Cleanup completed.');
+            }
+            catch {
+                console.error('⚠️  Could not clean up partial installation.');
+                console.error(`   Please manually remove: ${options.targetDir}`);
+            }
+        }
+        process.exit(1);
+    }
+}
+void createNextjsCms();

package/dist/lib/utils.d.ts

@@ -0,0 +1,11 @@
+/** Expand ~ to home */
+export declare function expandHome(p: string): string;
+/** Validate npm package name (simple rule) */
+export declare function isValidPkgName(name: string): boolean;
+/** Check if a directory is empty */
+export declare function isEmptyDir(dir: string): Promise<boolean>;
+/** Detect preferred package manager */
+export declare function detectPackageManager(): 'pnpm' | 'npm' | 'yarn' | 'bun';
+/** Validate template structure */
+export declare function validateTemplate(templateDir: string): Promise<void>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/lib/utils.ts"],"names":[],"mappings":"AAIA,uBAAuB;AACvB,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAG5C;AAED,8CAA8C;AAC9C,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED,oCAAoC;AACpC,wBAAsB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAO9D;AAED,uCAAuC;AACvC,wBAAgB,oBAAoB,IAAI,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAMtE;AAED,kCAAkC;AAClC,wBAAsB,gBAAgB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAczE"}

package/dist/lib/utils.js

@@ -0,0 +1,48 @@
+import fs from 'fs-extra';
+import path from 'node:path';
+import os from 'node:os';
+/** Expand ~ to home */
+export function expandHome(p) {
+    if (p.startsWith('~'))
+        return path.join(os.homedir(), p.slice(1));
+    return p;
+}
+/** Validate npm package name (simple rule) */
+export function isValidPkgName(name) {
+    return /^[a-zA-Z0-9-_]+$/.test(name);
+}
+/** Check if a directory is empty */
+export async function isEmptyDir(dir) {
+    try {
+        const entries = await fs.readdir(dir);
+        return entries.length === 0;
+    }
+    catch {
+        return true;
+    }
+}
+/** Detect preferred package manager */
+export function detectPackageManager() {
+    const userAgent = process.env.npm_config_user_agent;
+    if (userAgent?.includes('pnpm'))
+        return 'pnpm';
+    if (userAgent?.includes('yarn'))
+        return 'yarn';
+    if (userAgent?.includes('bun'))
+        return 'bun';
+    return 'npm';
+}
+/** Validate template structure */
+export async function validateTemplate(templateDir) {
+    const requiredFiles = ['package.json', 'next.config.ts', 'app/layout.tsx'];
+    const missingFiles = [];
+    for (const file of requiredFiles) {
+        if (!(await fs.pathExists(path.join(templateDir, file)))) {
+            missingFiles.push(file);
+        }
+    }
+    if (missingFiles.length > 0) {
+        console.warn('⚠️  Template missing some files:');
+        missingFiles.forEach((file) => console.warn(`   - ${file}`));
+    }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "create-nextjs-cms",
+  "version": "0.5.8",
+  "private": false,
+  "bin": {
+    "create-nextjs-cms": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "templates"
+  ],
+  "dependencies": {
+    "chalk": "^5.4.1",
+    "commander": "^14.0.2",
+    "fs-extra": "^11.3.0",
+    "glob": "^11.0.3",
+    "js-yaml": "^4.1.1",
+    "prompts": "^2.4.2",
+    "nextjs-cms": "0.5.8"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/js-yaml": "^4.0.9",
+    "@types/minimatch": "^5.1.2",
+    "@types/prompts": "^2.4.9",
+    "eslint": "^9.12.0",
+    "prettier": "^3.3.3",
+    "tsx": "^4.20.6",
+    "typescript": "^5.9.2",
+    "@lzcms/prettier-config": "0.1.0",
+    "@lzcms/eslint-config": "0.3.0",
+    "@lzcms/tsconfig": "0.1.0"
+  },
+  "prettier": "@lzcms/prettier-config",
+  "scripts": {
+    "dev": "tsc",
+    "prebuild": "tsx scripts/build.ts",
+    "build": "pnpm prebuild && tsc",
+    "clean": "git clean -xdf .cache .turbo dist node_modules",
+    "format": "prettier --check . --ignore-path ../../.gitignore",
+    "lint": "eslint",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/templates/default/.env

@@ -0,0 +1,24 @@
+ACCESS_TOKEN_SECRET=
+REFRESH_TOKEN_SECRET=
+CSRF_TOKEN_SECRET=
+ACCESS_TOKEN_EXPIRATION=
+REFRESH_TOKEN_EXPIRATION=
+
+NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=
+NEXT_PUBLIC_RICHTEXT_INLINE_PUBLIC_URL=
+
+####
+# generated by the cpanel plugin script
+####
+CPANEL_DOMAIN=
+CPANEL_USER=
+CPANEL_PASSWORD=
+
+####
+# generated by the init script
+####
+DB_HOST=
+DB_PORT=
+DB_NAME=
+DB_USER=
+DB_PASSWORD=

package/templates/default/.env.development

@@ -0,0 +1,8 @@
+####
+# generated by the init script
+####
+DB_HOST=
+DB_PORT=
+DB_NAME=
+DB_USER=
+DB_PASSWORD=

package/templates/default/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["next/core-web-vitals", "prettier", "next", "plugin:drizzle/recommended"],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint", "prettier", "drizzle"]
+}

package/templates/default/.prettierignore

@@ -0,0 +1,7 @@
+build/*
+dist/*
+public/*
+.next/*
+node_modules/*
+package.json
+*.log

package/templates/default/.prettierrc.json

@@ -0,0 +1,19 @@
+{
+    "arrowParens": "always",
+    "bracketSpacing": true,
+    "embeddedLanguageFormatting": "auto",
+    "htmlWhitespaceSensitivity": "css",
+    "insertPragma": false,
+    "jsxSingleQuote": true,
+    "printWidth": 120,
+    "proseWrap": "preserve",
+    "quoteProps": "as-needed",
+    "requirePragma": false,
+    "semi": false,
+    "singleQuote": true,
+    "tabWidth": 4,
+    "trailingComma": "all",
+    "useTabs": false,
+    "vueIndentScriptAndStyle": false,
+    "plugins": ["prettier-plugin-tailwindcss"]
+}