# javieraviles/node-typescript-koa-rest

REST API boilerplate using NodeJS and KOA2, typescript. Logging and JWT as middlewares. TypeORM with class-validator, SQL CRUD. Docker included. Swagger docs, actions CI and valuable README

Repository: https://github.com/javieraviles/node-typescript-koa-rest
Canonical: https://ross.abutalabs.com/products/node-typescript-koa-rest
Homepage: https://node-typescript-koa-rest.herokuapp.com/swagger-html
Language: TypeScript
License: MIT
License Family: permissive
Topics: node, koa, koa2, typescript, rest-api, koa-router, koa-jwt, winston, nodemon, docker, sql, typeorm, crud, class-validator, heroku, cors, jwt, helmet, swagger, github-actions
Last push: 2024-03-15T12:19:28+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 3035, "days_push": 901, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1015, forks 169 (observed 2026-08-28T04:03:14.272282+00:00)

## What it is
A REST API boilerplate for Node.js using Koa2 and TypeScript, with TypeORM for SQL CRUD, JWT/CORS/Winston/Helmet middlewares, and Swagger docs. It ships with Docker support, GitHub Actions CI, and a demo deployment on Heroku.

## Use cases
- bootstrap a TypeScript REST API with Koa
- set up a Node.js API with TypeORM and SQL
- start a REST API project with JWT auth and Swagger docs
- get a Docker-ready Node TypeScript API template
- learn a well-structured Koa2 project setup
- scaffold an API with CI/CD via GitHub Actions

## When to choose
- you want a ready-made Koa + TypeScript + TypeORM starting point
- you need JWT auth, validation, logging, and Swagger wired up out of the box
- you want Docker and CI included in a starter project

## When to avoid
- you need a production framework rather than a starter template
- you prefer Express, Fastify, or NestJS over Koa
- you use a NoSQL database instead of SQL via TypeORM

## Facets
- artifact type: learning-resource
- maturity: maintenance
- function: web-framework, api-framework, auth, orm, logging, middleware, routing, documentation, http-server
- domain: web-development, backend, apis, developer-tools
- platform: cli
- tags: koa, rest-api, typeorm, jwt, swagger, class-validator, starter-template, github-actions, boilerplate, nodejs, typescript, docker

## Member repositories
- javieraviles/node-typescript-koa-rest (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:03:14.272282+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T08:33:50.897199+00:00, confidence not recorded.
  - readme: https://github.com/javieraviles/node-typescript-koa-rest (fetched 2026-08-28T04:03:14.272282+00:00, sha 8453ca751bf5)
  - registry_npm: https://registry.npmjs.org/node-typescript-koa-rest (fetched 2026-08-29T13:10:54.033044+00:00, sha 30509deccb7d)
- Data as of 2026-08-30T08:39:29.467469+00:00.
