pixelfix / pixelfix
PixelFix application starter
Package info
github.com/PixelFixFramework/pixelfix
Language:Twig
Type:project
pkg:composer/pixelfix/pixelfix
Requires
- php: ^8.2
- npm-asset/bootstrap: ^5.3.8
- npm-asset/bootstrap-icons: ^1.13.1
- npm-asset/jquery: ^3.7.1
- npm-asset/overlayscrollbars: ^2.11.0
- npm-asset/toastr: ^2.1.4
- npm-asset/zebra_dialog: ^3.1.0
- pixelfix/framework: ^0.1.34
Requires (Dev)
- fakerphp/faker: ^1.24
Suggests
- dompdf/dompdf: Optional: enables PDF export through PixelFix exports(); requires the PHP extensions required by Dompdf.
- mongodb/mongodb: Required to use MongoDB database connections.
- phpoffice/phpspreadsheet: Optional: enables XLSX, XLS, CSV and ODS spreadsheet exports through PixelFix exports(); requires the PHP extensions required by PhpSpreadsheet.
Provides
None
Conflicts
None
Replaces
None
README
A starter application for building web applications with PixelFix.
Requirements
- PHP 8.2 or later
- Composer 2.x
- Authorized access to the PixelFix framework repository while it remains private
Installation
Choose either of the following methods to create your PixelFix application.
Option 1: Install using Composer
Create a new application directly from the PixelFix starter package:
composer create-project pixelfix/pixelfix my-app
Navigate to the application directory:
cd my-app
Option 2: Install using the PixelFix CLI Installer
Step 1: Install the CLI Installer globally.
composer global require pixelfix/installer
Verify the installation:
pixelfix --help
If PowerShell cannot find pixelfix, ensure Composer's global executable directory is included in your Windows PATH.
Step 2: Create your application.
pixelfix new my-app
Navigate to the application directory:
cd my-app
Run the application
After creating your application using either method, display the available commands:
php pixel help
Start the development server:
php pixel serve
If dependencies are missing or incomplete, run the following from the application root:
composer install
Note: Both installation methods require authorized access to PixelFixFramework/framework while the framework repository remains private. Configure Composer's GitHub authentication if prompted.
Documentation
The complete developer documentation is available here:
Read the PixelFix Documentation
Start with the Getting Started guides.
Feature guides
- PDF and Spreadsheet Exports — optional document generation, configuration, dependency setup and security guidance.
- Environment Reference — all starter environment options and their configuration files.
License
Proprietary.