Skip to content

getting-started.md

Latest commit

 

History

History
151 lines (104 loc) · 2.77 KB

getting-started.md

File metadata and controls

151 lines (104 loc) · 2.77 KB

Getting Started

This guide gets you from install to a runnable PhalconKit application. If your main goal is a REST API, read this first and then continue with the Build Your First REST Resource.

1. Create Or Install

For a new application, start from the phalcon-kit/app skeleton:

composer create-project phalcon-kit/app my-api
cd my-api

For an existing Phalcon application:

composer require phalcon-kit/core

Use phalcon-kit/core for new projects. The old zemit-cms/core package name exists only for historical projects and pinned legacy installs.

2. Configure The Environment

Create or update .env:

APP_NAME="My API"

DATABASE_HOST=127.0.0.1
DATABASE_DBNAME=my_api
DATABASE_USERNAME=my_api
DATABASE_PASSWORD=secret

The app config reads environment values and registers modules, providers, aliases, permissions, and integrations. Keep secrets in .env; keep structure in app/Config.

3. Check The Project Shape

A normal app has a small bootstrap and clear ownership boundaries:

app/
  Bootstrap.php
  Config/
  Models/
  Modules/Api/
resources/
  migrations/
public/
  index.php
loader.php
index.php
cli
websocket

Point the web server at public/, not the project root.

4. Run Locally

For a quick local test:

php -S 127.0.0.1:8000 -t public public/index.php

For production-like development, use PHP-FPM behind Nginx, Apache, Caddy, or a container proxy. See Web Server And WebSocket.

5. Verify Tooling

After installing dependencies:

composer validate --strict --no-check-publish
composer phpunit

If the application uses the database:

./bin/migration-list.sh
./bin/migration-run.sh

6. Build The First API Resource

The fastest path is:

  1. Create the table.
  2. Run migrations.
  3. Run the scaffolder.
  4. Add a model-backed API controller.
  5. Configure permissions.

The full example is in Build Your First REST Resource.

Useful Entrypoints

Web entrypoint:

<?php

use App\Bootstrap;

require 'loader.php';

echo (new Bootstrap())->run();

CLI entrypoint:

#!/usr/bin/env php
<?php

use App\Bootstrap;

require 'loader.php';

echo (new Bootstrap('cli'))->run();

WebSocket entrypoint:

#!/usr/bin/env php
<?php

use App\Bootstrap;

require 'loader.php';

echo (new Bootstrap('ws'))->run();

Next Steps