Build Your Application With PhalconKit
PhalconKit adds REST resources, database scaffolding, model relationships, authentication, permissions, and shared HTTP/CLI/WebSocket infrastructure to Phalcon. Your application defines its schema, business rules, and public API.
Start With A Working API
composer create-project phalcon-kit/app my-api
cd my-api
cp .env.example .env
php -S 127.0.0.1:8080 -t public public/index.php
Then request http://127.0.0.1:8080/api. The starter responds with HTTP 200. See Getting Started for PHP/Phalcon requirements, database configuration, and deployment setup.
Follow Your First REST Resource to turn a table into a controlled API. The tutorial includes the schema, generated model paths, controller policies, permissions, requests, and actual response examples.
Understand How It Fits Together
PhalconKit is still Phalcon: one bootstrap reads your config, registers a DI service per provider, and runs the same application over HTTP, the CLI, or a WebSocket worker. Application Structure shows where your code belongs, and How A Request Runs follows a request from the entrypoint through the permission checks to your controller.
What Are You Building?
| Application task | Start here |
|---|---|
| A new backend | Install and run |
| Core inside an existing Phalcon project | Application integration |
| Search and list screens | Filters, pagination, and sorting |
| Forms and batch editing | Writes and validation |
| Detail screens with related records | Relationships |
| Dashboards and downloads | Counts, facets, and exports |
| Authenticated application users | Login, refresh, logout, and account commands |
| Private or tenant-owned resources | Permissions and row scope |
| A change history for records | Opt-in audit trail |
| Scheduled tasks | CLI commands |
| Live notifications | WebSockets and application subscriptions |
Use The API Confidently
The REST handbook covers built-in actions and their policies. Use Requests And Responses for client integration and the scenario checklist to verify empty results, errors, batches, permissions, and relationship edge cases.
Changing an existing application? Use the migration index for package, REST, Core, and App changes.
Look Something Up
| Question | Reference |
|---|---|
| Which variable sets this option, and what is its default? | Environment variables |
| Which DI service does this, and how do I replace it? | Services |
| Which CLI tasks, actions, and options exist? | CLI commands |
| What does this class or method do? | API reference |
Browse all guides, or ask a usage question in Discussions.