| --- |
| license: other |
| language: |
| - en |
| tags: |
| - code-analysis |
| - static-analysis |
| - javascript |
| - electron |
| - emoji-cleaner |
| - junk-sweeper |
| - plugin-management |
| - desktop-app |
| - electron-app |
| - security |
| --- |
| # Chahuadev Framework - Plugin Management System |
|
|
| > Electron-based Desktop Application for Managing and Executing NPM Projects |
|
|
| --- |
|
|
| ## Documentation |
|
|
| All documentation files have been organized in the `docs/` folder: |
|
|
| ### Core Documentation |
| - **[docs/README.md](docs/README.md)** - Original project README |
| - **[docs/IMPLEMENTATION_COMPLETE.txt](docs/IMPLEMENTATION_COMPLETE.txt)** - Project implementation status |
| - **[docs/EMOJI_REMOVAL_COMPLETE.md](docs/EMOJI_REMOVAL_COMPLETE.md)** - Emoji removal system documentation |
|
|
| ### Authentication & Security |
| - **[docs/OFFLINE_AUTH_GUIDE.md](docs/OFFLINE_AUTH_GUIDE.md)** - Offline authentication system guide |
| - **[docs/OFFLINE_AUTH_CHANGES.md](docs/OFFLINE_AUTH_CHANGES.md)** - Offline authentication changes and implementation |
| - **[docs/AUTH_SECURITY_GUIDE.md](docs/AUTH_SECURITY_GUIDE.md)** - Authentication security in ValidationGateway |
| - **[docs/AUTH_SECURITY_IMPLEMENTATION.txt](docs/AUTH_SECURITY_IMPLEMENTATION.txt)** - Auth security implementation details |
| - **[docs/SWITCH_TO_OAUTH_GUIDE.md](docs/SWITCH_TO_OAUTH_GUIDE.md)** - How to switch back to OAuth |
|
|
| --- |
|
|
| ## 🐧 Running the AppImage on Linux / WSL2 (Ubuntu) |
|
|
| First install the required system libraries (one-time setup): |
|
|
| ```bash |
| sudo apt-get update && sudo apt-get install -y \ |
| libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 \ |
| libdrm2 libxkbcommon0 libxcomposite1 libxdamage1 \ |
| libxrandr2 libgbm1 libasound2 |
| ``` |
|
|
| Then run the AppImage: |
|
|
| ```bash |
| chmod +x "Chahuadev-Framework.AppImage" |
| DISPLAY=:0 WAYLAND_DISPLAY=wayland-0 \ |
| ./"Chahuadev-Framework.AppImage" \ |
| --appimage-extract-and-run --no-sandbox --disable-gpu |
| ``` |
|
|
| > **WSL2 tip:** Copy the AppImage to the WSL native filesystem first for best performance: |
| > ```bash |
| > # Path after: npm install -g @chahuadev/framework |
| > # (no sudo) |
| > cp ~/.npm-global/lib/node_modules/@chahuadev/framework/bin/Chahuadev-Framework.AppImage /tmp/ChahuadevFramework.AppImage |
| > # (with sudo) |
| > # cp /usr/lib/node_modules/@chahuadev/framework/bin/Chahuadev-Framework.AppImage /tmp/ChahuadevFramework.AppImage |
| > chmod +x /tmp/ChahuadevFramework.AppImage |
| > DISPLAY=:0 WAYLAND_DISPLAY=wayland-0 /tmp/ChahuadevFramework.AppImage \ |
| > --appimage-extract-and-run --no-sandbox --disable-gpu |
| > ``` |
| |
| --- |
| |
| ## Quick Start |
| |
| ```bash |
| # Install dependencies |
| npm install |
| |
| # Start development server |
| npm start |
| |
| # Start with dev mode |
| npm run dev |
| |
| # Generate builds |
| npm run build # All platforms |
| npm run build-win # Windows only |
| npm run build-msi # MSI installer |
| npm run build-exe # Portable executable |
| npm run build-nsis # NSIS installer |
| ``` |
| |
| --- |
| |
| ## Key Features |
| |
| **Offline Authentication** - No internet connection required |
| **SVG Icon System** - 40+ SVG icons for UI/logging |
| **Fort-Knox Security** - Anti-debugging, tamper detection, runtime integrity checks |
| **Gateway Pattern** - Centralized command processing and validation |
| **Multi-User Support** - Admin, Developer, User roles with permission levels |
| **Plugin Management** - Load and execute NPM projects as plugins |
| |
| --- |
| |
| ## Project Structure |
| |
| ``` |
| chahuadev-framework/ |
| ├── docs/ # Documentation (moved here) |
| │ ├── README.md |
| │ ├── IMPLEMENTATION_COMPLETE.txt |
| │ ├── OFFLINE_AUTH_GUIDE.md |
| │ ├── AUTH_SECURITY_GUIDE.md |
| │ └── ... |
| ├── src/ |
| ├── backend/ # Backend utilities |
| ├── modules/ # Core modules |
| │ ├── svg-icons.js # SVG icon system (40+ icons) |
| │ ├── tamper-detector.js |
| │ └── ... |
| ├── scripts/ # Build and utility scripts |
| ├── main.js # Electron main process |
| ├── preload.js # Preload script for IPC |
| ├── index.html # Main UI |
| ├── validation_gateway.js # Command gateway with auth |
| └── package.json |
| ``` |
| |
| --- |
| |
| ## Authentication System |
| |
| ### Demo Users (Offline Mode) |
| ``` |
| Username: admin | Password: demo123 | Role: Administrator | Permissions: read, write, admin |
| Username: developer | Password: demo123 | Role: Developer | Permissions: read, write |
| Username: user | Password: demo123 | Role: User | Permissions: read |
| ``` |
| |
| ### Token Storage |
| - Location: `~/.chahuadev/auth.json` |
| - Expiration: 24 hours |
| |
| ### Permission Levels |
| - `read` - View data, list plugins |
| - `write` - Run commands, execute npm |
| - `admin` - System configuration, auth checks |
| |
| --- |
| |
| ## Security Features |
| |
| ### Fort-Knox Level Security |
| - Anti-debugging protection |
| - Tamper detection system |
| - Runtime integrity checks |
| - DevTools protection |
| - Supply chain security verification |
| |
| ### Authentication Security |
| - Account lockout (5 attempts, 5-minute timeout) |
| - Token expiration checking |
| - Permission-based access control |
| - Command-level authentication checks |
| |
| ### Command Security |
| - IPC command sanitization |
| - Dangerous pattern detection |
| - Whitelist-based execution |
| - Plugin signature verification |
| |
| --- |
| |
| ## Logging System |
| |
| ### Text-based Logging Tags |
| Instead of emoji, the system now uses text-based tags: |
| |
| ``` |
| [SUCCESS] - Operation successful |
| [ERROR] - Error occurred |
| [FAILED] - Operation failed |
| [DENIED] - Access denied |
| [LOCKED] - Account/resource locked |
| [UNLOCKED] - Account/resource unlocked |
| [EXPIRED] - Token expired |
| [AUTH] - Authentication operation |
| [PERMISSION] - Permission check |
| [GATEWAY] - Gateway operation |
| [ADMIN] - Administrator action |
| [DEV] - Developer action |
| [USER] - User action |
| ``` |
| |
| --- |
| |
| ## SVG Icons System |
| |
| 40+ SVG icons available in `modules/svg-icons.js`: |
| |
| ### Security & Auth Icons |
| - lock, unlock, shield, checkCircle, alertCircle, xCircle |
| - userCheck, userX, user, users |
| |
| ### System Icons |
| - zap, settings, loader, refresh, eye, eyeOff |
| - check, x, alertTriangle, info, bell, clock |
| |
| ### Usage |
| ```javascript |
| const SVGIcons = require('./modules/svg-icons.js'); |
| |
| // Get SVG string |
| const svg = SVGIcons.getSVG('lock', 'icon-small'); |
| |
| // Create DOM element |
| const elem = SVGIcons.createSVGElement('user', 'user-icon'); |
| ``` |
| |
| --- |
| |
| ## Development Commands |
| |
| ```bash |
| # Start development |
| npm start # Normal start |
| npm run dev # Development mode |
| npm run dev-mode # Development mode with flags |
| |
| # Security |
| npm run generate-checksums # Generate file checksums |
| npm run security:check # Run security checks |
| npm run security:audit # Audit dependencies |
| npm run security:report # Generate security report |
| |
| # Building |
| npm run build # Build all platforms |
| npm run build-win # Windows build |
| npm run build-msi # MSI installer |
| npm run build-exe # Portable executable |
| npm run build-nsis # NSIS installer |
| |
| # Testing |
| npm test # Run tests |
| npm run test:logo # Test logo system |
| ``` |
| |
| --- |
| |
| ## For More Information |
| |
| - See **[docs/](docs/)** folder for detailed documentation |
| - Check specific guides for authentication, security, and emoji removal |
| - Review `AUTH_SECURITY_GUIDE.md` for authentication implementation details |
| |
| --- |
| |
| ## License |
| |
| Non-Commercial & Acceptable Use — See [LICENSE.md](LICENSE.md) |
| |
| --- |
| |
| ## Contributing |
| |
| For contributing guidelines, see the main documentation files in `docs/` folder |
| |
| --- |
| |
| **Status**: Production Ready |
| **Version**: 1.0.0 |
| **Last Updated**: February 17, 2026 |
| |
| --- |
| |
| *Chahuadev Framework - Making Project Management Simple & Secure* |
| |
