Get started

From package to first route

Set up a licensed Cimply.Work 4.0.3 project with a small, auditable application structure.

02

Install the package

Add the signed Enterprise release to your project and install its declared dependencies.

bash
composer install --no-dev --classmap-authoritative
03

Create the project structure

Keep project configuration and controllers inside one named project folder.

text
backend/
├── license.key
├── projects/api/
│   ├── config.yml
│   ├── routing.yml
│   ├── globals.yml
│   └── controller/
└── vendor/
04

Bootstrap Cimply.Work

Load the framework and execute the project. License validation happens before project services are registered.

php
$root = dirname(__DIR__);
(new Cimply\Work([$root . '/src']))
    ->app('api', $root . '/projects/api')
    ->run()?->execute();
05

Define the first route

Map the request to a callable controller action and choose the response type.

yaml
status:
  type: "application/json"
  action: \Acme\Api\Controller\StatusCtrl::show
06

Place the license at the consumer root

The runtime reads license.key above the projects directory. Version, host, consumer folder and project folder must match the signed claims.

backend/license.keyRS256 · 4.0.3 · host · consumer · project