@mtldev514/retro-portfolio-engine 1.0.0

package/index.js

@@ -0,0 +1,35 @@
+/**
+ * @retro-portfolio/engine
+ * Main entry point for the package
+ */
+
+const path = require('path');
+
+module.exports = {
+  // Path to engine files
+  enginePath: path.join(__dirname, 'engine'),
+
+  // Package version
+  version: require('./package.json').version,
+
+  /**
+   * Get path to engine directory
+   */
+  getEnginePath() {
+    return this.enginePath;
+  },
+
+  /**
+   * Get package version
+   */
+  getVersion() {
+    return this.version;
+  },
+
+  /**
+   * Get path to a specific engine file
+   */
+  getEngineFile(filePath) {
+    return path.join(this.enginePath, filePath);
+  }
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@mtldev514/retro-portfolio-engine",
+  "version": "1.0.0",
+  "description": "Retro portfolio site engine - Package as a Service. Users install this package and provide their own data.",
+  "main": "index.js",
+  "bin": {
+    "retro-portfolio": "./bin/cli.js"
+  },
+  "scripts": {
+    "prepare": "node scripts/post-install.js"
+  },
+  "keywords": [
+    "portfolio",
+    "retro",
+    "static-site-generator",
+    "site-as-a-package",
+    "90s-aesthetic",
+    "personal-website"
+  ],
+  "author": "Alex",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mtldev514/retro-portfolio-engine"
+  },
+  "files": [
+    "engine/",
+    "scripts/",
+    "bin/",
+    "templates/",
+    "index.js"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^11.0.0",
+    "fs-extra": "^11.1.1"
+  },
+  "devDependencies": {
+    "http-server": "^14.1.1"
+  },
+  "peerDependencies": {},
+  "publishConfig": {
+    "access": "restricted"
+  }
+}

package/scripts/admin.js

@@ -0,0 +1,67 @@
+/**
+ * Admin Script
+ * Launches admin interface for content management
+ */
+
+const { spawn } = require('child_process');
+const chalk = require('chalk');
+const path = require('path');
+const fs = require('fs-extra');
+
+async function admin(options = {}) {
+  const port = options.port || 5001;
+  const cwd = process.cwd();
+
+  console.log(chalk.blue('🔧 Starting admin interface...\n'));
+
+  // Check if admin_api.py exists in engine
+  const adminApiPath = path.join(__dirname, '../engine/admin_api.py');
+  const userDataPath = cwd;
+
+  if (!fs.existsSync(adminApiPath)) {
+    console.log(chalk.red('❌ Admin API not found in engine.'));
+    console.log(chalk.yellow('\nThe admin interface will be added in a future update.'));
+    console.log(chalk.gray('For now, you can edit JSON files in data/ and lang/ directly.\n'));
+    return;
+  }
+
+  // Set environment variable to point to user data
+  const env = {
+    ...process.env,
+    DATA_DIR: path.join(userDataPath, 'data'),
+    CONFIG_DIR: path.join(userDataPath, 'config'),
+    LANG_DIR: path.join(userDataPath, 'lang'),
+    PORT: port
+  };
+
+  console.log(chalk.cyan('Starting admin API...'));
+
+  // Start Flask API
+  const apiProcess = spawn('python3', [adminApiPath], {
+    env,
+    stdio: 'inherit'
+  });
+
+  console.log(chalk.green('\n✨ Admin interface running!\n'));
+  console.log(chalk.cyan('URL:'), `http://localhost:${port}/admin.html`);
+  console.log(chalk.gray('\nPress CTRL+C to stop\n'));
+
+  // Handle process termination
+  process.on('SIGINT', () => {
+    console.log(chalk.yellow('\n\n👋 Shutting down admin...'));
+    apiProcess.kill();
+    process.exit(0);
+  });
+
+  // Auto-open browser if requested
+  if (options.open) {
+    setTimeout(async () => {
+      const open = require('open');
+      await open(`http://localhost:${port}/admin.html`);
+    }, 2000); // Wait for Flask to start
+  }
+
+  return apiProcess;
+}
+
+module.exports = admin;

package/scripts/build.js

@@ -0,0 +1,142 @@
+/**
+ * Build Script
+ * Merges engine files with user data to generate static site
+ */
+
+const fs = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+
+async function build(options = {}) {
+  console.log(chalk.blue('🏗️  Building your portfolio...\n'));
+
+  const cwd = process.cwd();
+  const outputDir = path.join(cwd, options.output || 'dist');
+
+  // Validate user has required directories
+  const requiredDirs = ['config', 'data', 'lang'];
+  for (const dir of requiredDirs) {
+    if (!fs.existsSync(path.join(cwd, dir))) {
+      throw new Error(`Missing required directory: ${dir}/`);
+    }
+  }
+
+  console.log(chalk.cyan('📋 Validating data files...'));
+
+  // Validate config files exist
+  const requiredConfigs = ['app.json', 'languages.json', 'categories.json'];
+  for (const config of requiredConfigs) {
+    const configPath = path.join(cwd, 'config', config);
+    if (!fs.existsSync(configPath)) {
+      throw new Error(`Missing config file: config/${config}`);
+    }
+  }
+
+  console.log(chalk.green('  ✓ All data files present\n'));
+
+  // Clean output directory
+  console.log(chalk.cyan('🧹 Cleaning output directory...'));
+  await fs.emptyDir(outputDir);
+  console.log(chalk.green('  ✓ Output directory cleaned\n'));
+
+  // Copy engine files
+  console.log(chalk.cyan('📦 Copying engine files...'));
+
+  const enginePath = path.join(__dirname, '../engine');
+
+  if (!fs.existsSync(enginePath)) {
+    throw new Error('Engine files not found. Package may be corrupted.');
+  }
+
+  await fs.copy(enginePath, outputDir);
+
+  // Count files copied
+  const engineFiles = await fs.readdir(enginePath);
+  console.log(chalk.green(`  ✓ Copied ${engineFiles.length} engine files\n`));
+
+  // Copy user data
+  console.log(chalk.cyan('📄 Copying your data...'));
+
+  const dataDirs = ['config', 'data', 'lang'];
+  for (const dir of dataDirs) {
+    const srcPath = path.join(cwd, dir);
+    const destPath = path.join(outputDir, dir);
+
+    await fs.copy(srcPath, destPath);
+
+    const fileCount = (await fs.readdir(srcPath)).length;
+    console.log(chalk.green('  ✓'), `${dir}/ (${fileCount} files)`);
+  }
+
+  // Copy assets if exists
+  const assetsPath = path.join(cwd, 'assets');
+  if (fs.existsSync(assetsPath)) {
+    await fs.copy(assetsPath, path.join(outputDir, 'assets'));
+    const assetCount = (await fs.readdir(assetsPath)).length;
+    console.log(chalk.green('  ✓'), `assets/ (${assetCount} files)`);
+  }
+
+  // Create build info
+  const buildInfo = {
+    buildDate: new Date().toISOString(),
+    engine: {
+      name: '@retro-portfolio/engine',
+      version: require('../package.json').version
+    },
+    site: {
+      name: path.basename(cwd)
+    }
+  };
+
+  await fs.writeJson(path.join(outputDir, 'build-info.json'), buildInfo, {
+    spaces: 2
+  });
+
+  console.log(chalk.green('\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+  console.log(chalk.green('✨ Build completed successfully!\n'));
+  console.log(chalk.cyan('Output:'), outputDir);
+  console.log(chalk.cyan('Size:'), await getDirSize(outputDir));
+  console.log(chalk.green('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
+
+  console.log(chalk.gray('Next steps:'));
+  console.log(chalk.gray('  • Test locally: npm run dev'));
+  console.log(chalk.gray('  • Deploy: npm run deploy\n'));
+
+  return outputDir;
+}
+
+/**
+ * Get directory size in human-readable format
+ */
+async function getDirSize(dirPath) {
+  let size = 0;
+
+  async function calcSize(dir) {
+    const items = await fs.readdir(dir);
+
+    for (const item of items) {
+      const itemPath = path.join(dir, item);
+      const stats = await fs.stat(itemPath);
+
+      if (stats.isDirectory()) {
+        await calcSize(itemPath);
+      } else {
+        size += stats.size;
+      }
+    }
+  }
+
+  await calcSize(dirPath);
+
+  // Convert to human-readable
+  const units = ['B', 'KB', 'MB', 'GB'];
+  let unitIndex = 0;
+  while (size >= 1024 && unitIndex < units.length - 1) {
+    size /= 1024;
+    unitIndex++;
+  }
+
+  return `${size.toFixed(2)} ${units[unitIndex]}`;
+}
+
+module.exports = build;

package/scripts/init.js

@@ -0,0 +1,237 @@
+/**
+ * Init Script
+ * Creates a new portfolio with template data structure
+ */
+
+const fs = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+
+async function init(targetDir, options = {}) {
+  console.log(chalk.blue('🎨 Initializing Retro Portfolio...\n'));
+
+  const targetPath = path.resolve(process.cwd(), targetDir);
+  const templatePath = path.join(__dirname, '../templates/user-portfolio');
+
+  // Check if directory exists
+  if (fs.existsSync(targetPath) && fs.readdirSync(targetPath).length > 0) {
+    if (!options.force) {
+      throw new Error(
+        `Directory ${targetDir} is not empty. Use --force to overwrite.`
+      );
+    }
+  }
+
+  // Create directory structure
+  console.log(chalk.cyan('📁 Creating directory structure...'));
+
+  const dirs = ['config', 'data', 'lang', 'assets'];
+  for (const dir of dirs) {
+    const dirPath = path.join(targetPath, dir);
+    await fs.ensureDir(dirPath);
+    console.log(chalk.green('  ✓'), dir + '/');
+  }
+
+  // Copy template files
+  console.log(chalk.cyan('\n📄 Creating template files...'));
+
+  // package.json
+  const packageJson = {
+    name: path.basename(targetPath),
+    version: '1.0.0',
+    private: true,
+    scripts: {
+      build: 'retro-portfolio build',
+      dev: 'retro-portfolio dev',
+      admin: 'retro-portfolio admin',
+      deploy: 'retro-portfolio deploy'
+    },
+    dependencies: {
+      '@retro-portfolio/engine': '^1.0.0'
+    }
+  };
+
+  await fs.writeJson(path.join(targetPath, 'package.json'), packageJson, {
+    spaces: 2
+  });
+  console.log(chalk.green('  ✓'), 'package.json');
+
+  // .gitignore
+  const gitignore = `# Dependencies
+node_modules/
+
+# Build output
+dist/
+
+# Environment
+.env
+.env.local
+
+# Editor
+.vscode/
+.idea/
+*.swp
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Temp
+temp_uploads/
+.cache/
+`;
+
+  await fs.writeFile(path.join(targetPath, '.gitignore'), gitignore);
+  console.log(chalk.green('  ✓'), '.gitignore');
+
+  // .env.example
+  const envExample = `# Cloudinary Configuration (for media uploads)
+CLOUDINARY_CLOUD_NAME=your_cloud_name
+CLOUDINARY_API_KEY=your_api_key
+CLOUDINARY_API_SECRET=your_api_secret
+
+# Optional: Custom engine version
+# ENGINE_VERSION=1.0.0
+`;
+
+  await fs.writeFile(path.join(targetPath, '.env.example'), envExample);
+  console.log(chalk.green('  ✓'), '.env.example');
+
+  // Create config files
+  const configFiles = {
+    'config/app.json': {
+      site: {
+        name: 'My Retro Portfolio',
+        description: 'A nostalgic web presence',
+        author: 'Your Name'
+      },
+      theme: {
+        default: 'jr16'
+      }
+    },
+    'config/languages.json': {
+      defaultLanguage: 'en',
+      supportedLanguages: [
+        { code: 'en', name: 'English', flag: '🇬🇧' },
+        { code: 'fr', name: 'Français', flag: '🇫🇷' }
+      ]
+    },
+    'config/categories.json': {
+      contentTypes: [
+        {
+          id: 'painting',
+          name: { en: 'Painting', fr: 'Peinture' },
+          icon: '🎨',
+          mediaType: 'image',
+          dataFile: 'data/painting.json'
+        },
+        {
+          id: 'projects',
+          name: { en: 'Projects', fr: 'Projets' },
+          icon: '💻',
+          mediaType: 'code',
+          dataFile: 'data/projects.json'
+        }
+      ]
+    },
+    'config/media-types.json': {
+      mediaTypes: [
+        {
+          id: 'image',
+          name: 'Image',
+          supportsGallery: true,
+          acceptedFormats: ['jpg', 'png', 'gif', 'webp']
+        },
+        {
+          id: 'code',
+          name: 'Code Project',
+          supportsGallery: false
+        }
+      ]
+    }
+  };
+
+  for (const [filePath, content] of Object.entries(configFiles)) {
+    const fullPath = path.join(targetPath, filePath);
+    await fs.writeJson(fullPath, content, { spaces: 2 });
+    console.log(chalk.green('  ✓'), filePath);
+  }
+
+  // Create empty data files
+  const dataFiles = ['painting', 'projects'];
+  for (const file of dataFiles) {
+    const filePath = path.join(targetPath, 'data', `${file}.json`);
+    await fs.writeJson(filePath, { items: [] }, { spaces: 2 });
+    console.log(chalk.green('  ✓'), `data/${file}.json`);
+  }
+
+  // Create language files
+  const langFiles = {
+    'lang/en.json': {
+      header_title: 'My Portfolio',
+      nav_painting: 'Painting',
+      nav_projects: 'Projects',
+      footer_copy: '© 2026 My Portfolio'
+    },
+    'lang/fr.json': {
+      header_title: 'Mon Portfolio',
+      nav_painting: 'Peinture',
+      nav_projects: 'Projets',
+      footer_copy: '© 2026 Mon Portfolio'
+    }
+  };
+
+  for (const [filePath, content] of Object.entries(langFiles)) {
+    const fullPath = path.join(targetPath, filePath);
+    await fs.writeJson(fullPath, content, { spaces: 2 });
+    console.log(chalk.green('  ✓'), filePath);
+  }
+
+  // Create README
+  const readme = `# My Retro Portfolio
+
+A retro-styled portfolio powered by @retro-portfolio/engine.
+
+## Quick Start
+
+\`\`\`bash
+# Install dependencies
+npm install
+
+# Start development server
+npm run dev
+
+# Build for production
+npm run build
+
+# Launch admin interface
+npm run admin
+\`\`\`
+
+## Project Structure
+
+- \`config/\` - Site configuration
+- \`data/\` - Your portfolio content (JSON)
+- \`lang/\` - Translations
+- \`assets/\` - Your images, files, etc.
+
+## Documentation
+
+Visit [retro-portfolio documentation](https://github.com/YOUR_USERNAME/retro-portfolio-engine) for more info.
+`;
+
+  await fs.writeFile(path.join(targetPath, 'README.md'), readme);
+  console.log(chalk.green('  ✓'), 'README.md');
+
+  // Success message
+  console.log(chalk.green('\n✨ Portfolio initialized successfully!\n'));
+  console.log(chalk.cyan('Next steps:\n'));
+  console.log(`  cd ${targetDir}`);
+  console.log('  npm install');
+  console.log('  npm run dev\n');
+  console.log(chalk.gray('Happy creating! 🎨\n'));
+
+  return true;
+}
+
+module.exports = init;

package/scripts/post-install.js

@@ -0,0 +1,16 @@
+/**
+ * Post-install script
+ * Runs after npm install (optional setup)
+ */
+
+// Nothing required for now - this can be used later for:
+// - Creating default config files
+// - Setting up initial directories
+// - Showing welcome message
+
+console.log('✅ @retro-portfolio/engine installed successfully!');
+console.log('\nGet started with:');
+console.log('  npx retro-portfolio init my-portfolio');
+console.log('  cd my-portfolio');
+console.log('  npm install');
+console.log('  npm run dev\n');

package/scripts/serve.js

@@ -0,0 +1,54 @@
+/**
+ * Serve Script
+ * Local development server with live reload
+ */
+
+const { spawn } = require('child_process');
+const chalk = require('chalk');
+const path = require('path');
+const fs = require('fs-extra');
+
+async function serve(options = {}) {
+  const port = options.port || 8000;
+  const cwd = process.cwd();
+  const distPath = path.join(cwd, 'dist');
+
+  console.log(chalk.blue('🚀 Starting development server...\n'));
+
+  // Check if dist exists, if not build first
+  if (!fs.existsSync(distPath)) {
+    console.log(chalk.yellow('⚠️  No build found. Building first...\n'));
+    const build = require('./build');
+    await build({ output: 'dist' });
+    console.log('');
+  }
+
+  // Start HTTP server
+  console.log(chalk.cyan('Starting server...'));
+
+  const serverProcess = spawn('python3', ['-m', 'http.server', port], {
+    cwd: distPath,
+    stdio: 'inherit'
+  });
+
+  console.log(chalk.green('\n✨ Server running!\n'));
+  console.log(chalk.cyan('Local:'), `http://localhost:${port}`);
+  console.log(chalk.gray('\nPress CTRL+C to stop\n'));
+
+  // Handle process termination
+  process.on('SIGINT', () => {
+    console.log(chalk.yellow('\n\n👋 Shutting down server...'));
+    serverProcess.kill();
+    process.exit(0);
+  });
+
+  // Auto-open browser if requested
+  if (options.open) {
+    const open = require('open');
+    await open(`http://localhost:${port}`);
+  }
+
+  return serverProcess;
+}
+
+module.exports = serve;

package/templates/user-portfolio/.github/workflows/deploy.yml

@@ -0,0 +1,57 @@
+name: Build and Deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 📦 Checkout
+        uses: actions/checkout@v4
+
+      - name: 🔧 Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+
+      - name: 📥 Install dependencies
+        run: npm ci
+
+      - name: 🏗️ Build site
+        run: npm run build
+
+      - name: 📊 Build summary
+        run: |
+          echo "### 🎨 Build Complete" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "**Build date:** $(date -u +"%Y-%m-%d %H:%M:%S UTC")" >> $GITHUB_STEP_SUMMARY
+          echo "**Output:** dist/" >> $GITHUB_STEP_SUMMARY
+
+      - name: 📤 Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./dist
+
+      - name: 🚀 Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+
+      - name: ✅ Deployment complete
+        run: |
+          echo "### 🎉 Site deployed!" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "**URL:** ${{ steps.deployment.outputs.page_url }}" >> $GITHUB_STEP_SUMMARY

package/templates/user-portfolio/config/app.json

@@ -0,0 +1,36 @@
+{
+  "app": {
+    "name": "Retro Portfolio",
+    "version": "1.0",
+    "adminTitle": "PORTFOLIO MANAGER"
+  },
+  "api": {
+    "host": "127.0.0.1",
+    "port": 5001,
+    "baseUrl": "http://127.0.0.1:5001"
+  },
+  "paths": {
+    "dataDir": "data",
+    "langDir": "lang",
+    "pagesDir": "pages"
+  },
+  "github": {
+    "username": "yourusername",
+    "repoName": "retro-portfolio",
+    "mediaReleaseTag": "media",
+    "uploadCategories": [
+      "music"
+    ]
+  },
+  "counter": {
+    "apiUrl": "https://api.counterapi.dev/v1/retro-portfolio/visits/up"
+  },
+  "winamp": {
+    "title": "My Playlist",
+    "bitrate": "192",
+    "frequency": "44"
+  },
+  "pagination": {
+    "pageSize": 24
+  }
+}