Getting started
Create a new application
bash
npx pondoknusa new my-app
cd my-app
npm install
pondoknusa serveVisit http://127.0.0.1:3000.
Backend-only (headless API)
For JSON APIs without views, SSR, or client assets:
bash
npm create pondoknusa@latest my-api -- --headless
cd my-api
npm install
pondoknusa migrate
pondoknusa dev
curl http://127.0.0.1:3000/api/v1/healthSee the Headless API guide and examples/headless-api in the repo.
Run from the monorepo
If you are developing Pondoknusa itself, build the workspace first:
bash
npm install
npm run buildThen try the reference apps:
bash
cd examples/hello-world
npm install
pondoknusa servebash
cd examples/headless-api
npm install
pondoknusa migrate
pondoknusa devApplication entry point
Every app boots through src/main.ts:
typescript
import { Application, ConfigServiceProvider, Route, serve } from '@pondoknusa/core';
import { AppServiceProvider } from './providers/app-service-provider.js';
import './routes/web.js';
const app = new Application();
app.register(ConfigServiceProvider);
app.register(AppServiceProvider);
await app.boot();
serve(app);Routes are registered in src/routes/web.ts using the Route facade after setRouteApplication(app) is called from your provider.
CLI essentials
bash
pondoknusa list # Available commands
pondoknusa serve # Dev server (reads pondoknusa.json)
pondoknusa migrate # Run migrations
pondoknusa make:controller User # Generate a controller
pondoknusa make:model Post # Generate a model
pondoknusa auth:install # Scaffold auth (User, routes, migrations)Deploy to production
When you are ready to ship:
- Read the deployment overview — checklist, process model, health probes
- Pick a host via the platform matrix (Railway, Fly, Docker, or Cloudflare + origin)
- Automate releases with CI/CD
bash
pondoknusa deploy:check # doctor + route/view validation before trafficManaged Pondoknusa Cloud (git-push deploy) is planned — see Pondoknusa Cloud. Until then, copy manifests from examples/hello-world/deploy/.
Deploy to production
| Step | Guide |
|---|---|
| Pick a platform | Platform matrix |
| Fastest path | Railway or Fly.io |
| Cloudflare CDN + R2 | Cloudflare (Node origin required today) |
| Automate releases | CI/CD |
bash
pondoknusa migrate
pondoknusa config:cache && pondoknusa route:cache && pondoknusa view:cache
pondoknusa deploy:check
pondoknusa startFull checklist: Deployment. Managed Pondoknusa hosting is planned as Pondoknusa Cloud.
Next steps
- Application structure — folders, providers, and config
- Routing — groups, middleware, and controllers
- Database & ORM — models, migrations, and relationships
- Performance — production speed defaults
- Performance — production speed defaults