Build FOSSBilling from source when you want to contribute code, test changes locally, or package a customized version.
Prerequisites
Section titled “Prerequisites”Build Steps
Section titled “Build Steps”Clone the repository
Terminal window git clone https://github.com/FOSSBilling/FOSSBilling.gitcd FOSSBillingInstall PHP dependencies
Terminal window composer installInstall Node dependencies
Terminal window npm installBuild front-end assets
FOSSBilling uses esbuild. Run the build:
Terminal window npm run buildThis builds the shared frontend assets into
src/public/assetsand builds the bundledadmin_defaultandhuragatheme assets.Add translations (optional)
Download the latest translations and extract to
src/locale/, overwriting existing files.
After these steps, your checkout is ready for local development or for packaging into a deployment build.
Developer Tooling
Section titled “Developer Tooling”FOSSBilling bundles its development and CI tooling as a single console package in tools/. The tools package requires PHP 8.5 — a tighter requirement than FOSSBilling itself. After installing dependencies, the commands are available via:
composer install --working-dir=toolstools/bin/console listThis provides manifest:validate (validates bundled module manifests), i18n:* commands (translation extraction used by the locale repository's workflows), and demo:seed (populates an install with demo data).
Development Mode
Section titled “Development Mode”For active theme development, use the theme workspace scripts:
npm run build-admin_defaultnpm run build-huragaThe Huraga theme also supports watch mode:
cd src/themes/huraganpm run devRunning Locally
Section titled “Running Locally”You can use PHP's built-in server for quick testing:
cd srcphp -S localhost:8000Then visit http://localhost:8000 in your browser.