Getting Started

Install StoneScriptPHP and run your first PostgreSQL-backed API.

Requirements

Quick start

1. Create a project

The project skeleton is published on Packagist as progalaxyelabs/stonescriptphp-server.

composer create-project progalaxyelabs/stonescriptphp-server my-api
cd my-api

2. Configure your environment

composer create-project launches this wizard automatically. Re-run it any time, or copy .env.example to .env and edit it by hand.

php stone setup

3. Choose authentication (optional)

The skeleton ships with no auth routes; generate only what you need, then apply migrations.

php stone generate auth:email-password
php stone migrate up

4. Start the development server (requires Docker)

Uses Docker (Nginx + PHP-FPM) and serves the API at http://localhost:8000. Stop it with composer stop.

composer dev

5. Generate your TypeScript client

After adding routes, generate a typed client for your Angular or TypeScript front end.

php stone generate client

Run php stone help to list every command (code generation, migrations, seeding, tenants).

Learn more