Package Exports

@emithun/codefx
@emithun/codefx/core/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@emithun/codefx) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CodeFX

Modular multi-platform web framework — portfolio, community, and CMS in one codebase.

CodeFX is a complete personal/professional website framework designed with a "global" mindset: one codebase, multiple deployment targets. Build once, deploy anywhere.

Features

Modular architecture — Pick what you need: portfolio, blog, forums, tickets, analytics
Multi-platform — Static HTML (GitHub Pages), serverless (Vercel), full-stack (self-hosted), or shared hosting
Invisible login — Secret keyboard shortcut, no visible button
Click-to-edit CMS — Double-click any content to edit inline
Built-in forums — Tech, Plant, and Photography communities
Database abstraction — Flatfile (no deps), SQLite, PostgreSQL, or MySQL
Theme engine — 5 presets, custom colors, dark mode
Analytics — Visitor tracking with IP mapping
Contact & tickets — Email forms with SMTP support

Quick Start

# Create a new project (requires npm package — or clone repo below)
npx codefx init my-portfolio
cd my-portfolio
npm run build

# OR clone the framework directly
git clone https://github.com/eMithun/CodeFX.git
cd CodeFX
npm install
# edit codefx.config.yaml
npm run build

Documentation

Full documentation is in the docs/ directory:

Guide	Description
Getting Started	Install, configure, build your first site
Configuration	All config options reference
Module System	How modules work, built-in list, custom modules
Deployment	GitHub Pages, Vercel, self-hosted, shared hosting
CLI Reference	All CLI commands and options
Database	SQLite, PostgreSQL, MySQL, flatfile
Themes	Presets, customization, dark mode
Development	Contributing, architecture, building from source
Architecture	Full system design, ADRs, module dependency graph

Deployment Targets

Target	Mode	Command
GitHub Pages	`static`	Push `dist/` or use GitHub Actions
Vercel	`serverless`	`npx vercel`
Self-hosted	`fullstack`	`node cli serve`
Shared hosting	`shared`	Upload `dist/` via FTP

Architecture

CodeFX/
├── core/          # Engine: config, loader, builder, database
├── modules/       # Feature modules (auth, cms, forum, email, etc.)
├── cli/           # Command-line tools (init, build, serve, deploy)
├── config/        # Default config and presets
├── assets/        # CSS, JS, SVG icons
└── docs/          # Architecture docs, task management

Module System

Enable what you need in codefx.config.yaml:

modules:
  enabled:
    - portfolio    # Personal portfolio pages
    - theme        # Theme engine with presets
    - social       # Social media links with icons
    - auth         # Invisible login & profiles
    - cms          # Click-to-edit content management
    - email        # Contact form & email delivery
    - ticket       # Support ticket system
    - forum        # Community forums
    - analytics    # Visitor tracking & stats

Database

Driver	Use Case	Install
Flatfile	Static sites, no DB needed	Built-in
SQLite	Self-hosted, small scale	`npm install better-sqlite3`
PostgreSQL	Production	`npm install pg`
MySQL	Shared hosting	`npm install mysql2`

License

MIT