The hono-serverless-boilerplate from mandado

hono-serverless-boilerplate's Introduction

HONO serverless Boilerplate

Simple hono boilerplate to develop serverless applications on AWS.

Installing project

pnpm install

Testing offline api

pnpm offline

Generating code

pnpm g:module --name hello --route /hello

Features

Routing register using decorators on controller top on (https://hono.dev/)[https://hono.dev/]
Openapi routes @hono/zod-openapi with routing.
Dependency injection using @freshgum/typedi
Formatting and linting code using BiomeJS
Generating code using hygen.io
Enviroment type safe variables using env.t3.gg
Testing using https://vitest.dev/
Build serverless application using https://github.com/floydspace/serverless-esbuild
Emulates AWS λ and API Gateway using [https://github.com/dherault/serverless-offline](Serverless offline)

Examples

Open api Schema

import { createRoute, z } from "@infra/zod";

export const helloOpenApi = createRoute({
  request: {
    body: {
      content: {
        "application/json": {
          schema: z.object({
            name: z.string().openapi("name"),
          }),
        },
      },
    },
  },
  responses: {
    200: {
      content: {
        "application/json": {
          schema: z.object({
            message: z.string(),
          }),
        },
      },
      description: "Retrieve the user",
    },
  },
});

Routing

@Route("/hello")
@Service([])
export class HelloController {
  constructor() {}

  @Post("/", {
    openapi: helloOpenApi,
  })
  index(c: Context) {
    return c.json(
      {
        message1: "Hello, world!",
      },
      200
    );
  }
}

Dependency injection

import { Service } from "@infra/container";

@Service([])
class LogService {
  log(message: string) {
    console.log(message);
  }
}

@Service([LogService])
class RootService {
  constructor(private logger: LogService) {}
  run() {
    this.logger.log("hello world!");
  }
}