Developer getting started
Clone the framework, run composer setup and composer dev, run the test lanes and Pint, and find where the documentation lives.
Overview
This page gets a contributor from a fresh clone to a running development instance with passing tests. For building screens with the shared component library, see UI components. For installing Signals to run a business on it, see Installation.
Requirements
- PHP 8.4 or 8.5 with the
redis,bcmathandpdo_pgsqlextensions - Composer 2.x
- Node.js 22+
- PostgreSQL 15+ with the
btree_gistandpg_trgmextensions - Redis 7+ (recommended; a database fallback is available)
Clone and set up
git clone https://github.com/signals-rental/framework-core.git
cd framework-core
composer setup
composer setup installs the PHP and Node dependencies, makes sure a .env file exists, builds the frontend, and launches the install wizard (php artisan signals:install) for the database, Redis, storage and websockets. Then run php artisan signals:setup to create the company, warehouses, branding and admin account. Run php artisan signals:install again at any time to reconfigure infrastructure.
Run the development stack
composer dev
This starts five processes together: the web server (php artisan serve), a queue listener for the application queues, the log viewer (php artisan pail), the Vite dev server (npm run dev) and the Reverb websocket server. Stopping one stops them all. If a frontend change does not appear, check that the Vite process is running, or run npm run build.
Run the tests
composer test
composer test clears the config cache, checks formatting with Pint, audits the API documentation against the route export, and runs the main Pest suite in parallel. The main suite runs on SQLite in memory.
| Lane | Command | Notes |
|---|---|---|
| Main suite | vendor/bin/pest --parallel --tia |
Blocking; unaffected tests are replayed |
| Environment-writing tests | php artisan test --group=env-writing |
Blocking; runs sequentially |
| PostgreSQL tests | php artisan test --testsuite=Pgsql |
Blocking; serial, needs a pgsql connection |
| Browser smoke tests | composer test:browser |
Opt-in; needs npm run build and npx playwright install chromium |
composer test:all runs the main suite, the environment-writing group, the PostgreSQL suite and the conformance script in one go. While working on a change, run only the tests that cover it, for example php artisan test --compact --filter=TestName.
Format and analyse
composer lint # Pint, in parallel
vendor/bin/pint --dirty # format only files you changed
vendor/bin/phpstan analyse # static analysis
composer test:lint checks formatting without changing files; composer test runs it first.
Where the docs live
Documentation pages are Markdown files under docs/, rendered in the app at /docs. The navigation — sections, groups, page titles and descriptions — is defined in docs/documentation.json; a page that is not registered there is not published. Pages are grouped by audience: docs/platform/ holds feature and administration pages, docs/api/ the Integrations & API pages, and docs/development/ the Plugin SDK and Framework internals pages. Pages that cite source files carry reviewed and sources frontmatter so they can be flagged when those files change.
Docs pages support typed callouts (> [!NOTE], > [!TIP], > [!WARNING], > [!CAUTION], > [!IMPORTANT] and the > **Note:** form) and captioned figures (an image's title becomes its caption). The landing page's quick-start chips, audience paths and popular tasks come from docs/landing.json.