Getting Started

Create an application

Once bcp and create-bcp-app are published:

Bash

npx create-bcp-app my-app
cd my-app
npm run dev

The generator creates a React + TypeScript project with a root layout, home page, API example and bcp.config.ts.

Generated scripts

JSON

{
  "scripts": {
    "dev": "bcp dev",
    "build": "bcp build",
    "start": "bcp start",
    "routes": "bcp routes",
    "typecheck": "tsc --noEmit"
  }
}

First page

TypeScript

// app/page.tsx
export default function HomePage() {
    return (
        <main>
            <h1>Hello BCP</h1>
        </main>
    );
}

First API route

TypeScript

// app/api/hello/route.ts
export function GET() {
    return Response.json({
        message: "Hello",
    });
}

Inspect routes

Bash

npm run routes

Production

Bash

npm run build
npm start

The production server is standalone and reads build-time configuration from the generated server artifact while still allowing supported runtime environment and CLI server overrides.

Local tarball testing

Before npm publication, package artifacts can be created from the framework repository:

Bash

npm run package:check

Then a project can be generated against the local tarball:

Bash

node create-bcp-app/bin/create-bcp-app.mjs my-app \
  --no-install \
  --bcp file:../.package/artifacts/bcp-0.1.0.tgz

Introduction →