Code Generation

Create a project

npx @foal/cli createapp my-app

Create a new directory with all the required files to get started.

If you specify the flag --mongodb, the CLI will generate a new project using MongoDB instead of SQLite.

If you specify the flag --yaml, the new project will use YAML format for its configuration files. You can find more information here.

Create a controller

npx foal g controller <name>

Create a new controller in ./src/app/controllers, in ./controllers or in the current directory depending on which folders are found.

Example

npx foal g controller auth
npx foal g controller api/product

Output

src/
 '- app/
  '- controllers/
   |- api/
   | |- product.controller.ts
   | '- index.ts
   |- auth.controller.ts
   '- index.ts

The --register flag

npx foal g controller <name> --register

If you wish to automatically create a new route attached to this controller, you can use the --register flag to do so.

Example

npx foal g controller api --register
npx foal g controller api/product --register

Output

src/
 '- app/
  |- controllers/
  | |- api/
  | | |- product.controller.ts
  | | '- index.ts
  | |- api.controller.ts
  | '- index.ts
  '- app.controller.ts

app.controller.ts

export class AppController {
  subControllers = [
    controller('/api', ApiController)
  ]
}

api.controller.ts

export class ApiController {
  subControllers = [
    controller('/product', ProductController)
  ]
}

Create an entity

npx foal g entity <name>

Create a new entity in ./src/app/entities, in ./entities or in the current directory depending on which folders are found.

Example

npx foal g entity user
npx foal g entity business/product

Output

src/
 '- app/
  '- entities/
   |- business/
   | |- product.entity.ts
   | '- index.ts
   |- user.entity.ts
   '- index.ts

Create REST API

npx foal g rest-api <name>

Create a new controller and a new entity to build a basic REST API. Depending on which directories are found, they will be generated in src/app/{entities}|{controllers}/ or in {entities}|{controllers}/.

Example

npx foal g rest-api order
npx foal g rest-api api/product

Output

src/
 '- app/
  |- controllers/
  | |- api/
  | | |- product.controller.ts
  | | '- index.ts
  | |- order.controller.ts
  | '- index.ts
  '- entities/
    |- index.entity.ts
    |- order.entity.ts
    '- index.ts

The --register flag

If you wish to automatically create a new route attached to this controller, you can use the --register flag to do so (see create-a-controller).

Example

npx foal g controller api --register
npx foal g controller api/product --register

See the page REST Blueprints for more details.

Create a hook

npx foal g hook <name>

Create a new hook in ./src/app/hooks, in ./hooks or in the current directory depending on which folders are found.

Example

npx foal g hook log
npx foal g hook auth/admin-required

Output

src/
 '- app/
  '- hooks/
   |- auth/
   | |- admin-required.hook.ts
   | '- index.ts
   |- log.hook.ts
   '- index.ts

Create a script

npx foal g script <name>

Create a new shell script in src/scripts regardless of where you run the command.

Create a service

npx foal g service <name>

Create a new service in ./src/app/services, in ./services or in the current directory depending on which folders are found.

Example

npx foal g service auth
npx foal g service apis/github

Output

src/
 '- app/
  '- services/
   |- apis/
   | '- github.service.ts
   | '- index.ts
   |- auth.service.ts
   '- index.ts