cano-koa

Core framework for Cano - a modular Koa-based microframework with cube plugin architecture.

Installation

``bash
npm install cano-koa


or


pnpm add cano-koa
`

Usage

`typescript
import Cano from 'cano-koa';

const cano = new Cano(__dirname);
await cano.up();
`

Configuration

Create configuration files in the config/ directory:

$3

`typescript
import ControllersCube from 'cano-cube-controllers';
import ServicesCube from 'cano-cube-services';
import RoutersCube from 'cano-cube-routers';

export default [ControllersCube, ServicesCube, RoutersCube];
`

$3

`typescript
export default {
port: process.env.PORT || 3000,
env: process.env.NODE_ENV || 'development',
};
`

$3

`typescript
import cors from '@koa/cors';
import bodyParser from 'koa-bodyparser';

export default [cors(), bodyParser()];
`

Project Structure

`
my-app/
├── api/
│ ├── controllers/
│ ├── services/
│ ├── routers/
│ └── models/
├── config/
│ ├── cubes.ts
│ ├── web.ts
│ └── middlewares.ts
└── app.ts
`

API

$3

`typescript
class Cano extends Koa {
constructor(rootPath: string);

app: CanoApp;
log: Logger;

up(): Promise;
}
`

$3

`typescript
interface CanoApp {
paths: {
root: string;
config: string;
api: string;
};
config: AppConfig;
controllers?: Record;
services?: Record;
policies?: Record;
models?: Record;
routers?: Record;
}
`

Global Access

The Cano instance is available globally:

`typescript
// Access from anywhere
const cano = globalThis.cano;
``

Related Packages

- cano-cube - Base Cube class
- cano-cube-controllers - Controller loader
- cano-cube-services - Service loader
- cano-cube-routers - Router loader
- cano-cube-mongoose - Mongoose integration

License

Apache-2.0