{"id":14989718,"url":"https://github.com/ddimaria/koa-typescript-starter","last_synced_at":"2025-04-12T00:31:51.112Z","repository":{"id":67523508,"uuid":"126833501","full_name":"ddimaria/koa-typescript-starter","owner":"ddimaria","description":"Integrating TypeScript with KOA2 to hit the ground running faster","archived":false,"fork":false,"pushed_at":"2018-11-07T15:58:40.000Z","size":15,"stargazers_count":66,"open_issues_count":1,"forks_count":24,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-03-25T20:51:11.454Z","etag":null,"topics":["chai","coveralls","docker","docker-image","jasmine","koa2","travis-ci","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ddimaria.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-03-26T13:31:33.000Z","updated_at":"2024-11-04T10:12:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"1d7a1915-459d-4a66-a7e8-b7e52050958d","html_url":"https://github.com/ddimaria/koa-typescript-starter","commit_stats":{"total_commits":10,"total_committers":3,"mean_commits":"3.3333333333333335","dds":"0.30000000000000004","last_synced_commit":"5fd3c1ee9f71ebe6c20486c004726227be01b64b"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddimaria%2Fkoa-typescript-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddimaria%2Fkoa-typescript-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddimaria%2Fkoa-typescript-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ddimaria%2Fkoa-typescript-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ddimaria","download_url":"https://codeload.github.com/ddimaria/koa-typescript-starter/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248501350,"owners_count":21114660,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chai","coveralls","docker","docker-image","jasmine","koa2","travis-ci","typescript"],"created_at":"2024-09-24T14:18:49.130Z","updated_at":"2025-04-12T00:31:50.821Z","avatar_url":"https://github.com/ddimaria.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KOA2 TypeScript Starter\n\n[![Build Status](https://travis-ci.org/ddimaria/koa-typescript-starter.svg?branch=develop)](https://travis-ci.org/ddimaria/koa-typescript-starter)\n[![Coverage Status](https://coveralls.io/repos/github/ddimaria/koa-typescript-starter/badge.svg?branch=develop)](https://coveralls.io/github/ddimaria/koa-typescript-starter?branch=develop)\n\nA NodeJS server built with the KOA2 framework using TypeScript.\n\nTechnologies Used:\n\n* [KOA2](http://koajs.com/)\n* [TypeScript](https://www.typescriptlang.org/)\n* [Travis CLI](https://travis-ci.org/)\n* [Coveralls](https://coveralls.io/)\n* [Jasmine](https://jasmine.github.io/)\n* [Chai](http://www.chaijs.com/)\n* [Istanbul/NYC](https://github.com/istanbuljs/nyc)\n* [Lodash](https://lodash.com/)\n* [Nodemon](https://nodemon.io/)\n* [Docker](https://www.docker.com/)\n* [Swagger](https://swagger.io/)\n* [Bunyahn](https://github.com/trentm/node-bunyan)\n* [Koa Bunyan Logger](https://github.com/koajs/bunyan-logger/)\n\n## Prerequisites\n\n* Node.js (8+): recommend using [nvm](https://github.com/creationix/nvm)\n* Docker (if building a docker image) https://www.docker.com/docker-mac\n\n## Installation\n\nFirst, clone this repo and `cd` into the main directory. Then:\n\n```shell\nnpm install\n```\n\n## Development\n\nDuring development, the `/app` folder is being watched for changes.\n\nAll changes invoke the TypeScript compiler, which restarts the app upon completion.\n\n```shell\nnpm run watch\n```\n\n## Build the Server\n\nTo compile the TypeScript code and place into the `/dist` folder:\n\n```shell\nnpm build\n```\n\n## Code Linter\n\nA TypeScript linter has been added to keep code consistent among developers.\n\n```shell\nnpm run lint\n```\n\nTo autofix linting errors (not all errors are auto-fixable):\n\n```shell\nnpm run fix\n```\n\n## Tests and Coverage\n\nThe test coverage percentage should be 90% or greater for any submitted PRs.\n\nFor TDD, invoke testing by:\n\n```shell\nnpm test\n```\n\nFor an html and text coverage report (html located in the `/coverage` folder):\n\n```shell\nnpm run coverage\n```\n\n## Docker\n\nTo build a container using the `dockerfile`:\n\n```shell\nnpm run image:build -- --no-cache\n```\n\n---\n\n## API\n\nFor a swagger version of this documention, see http://localhost:3000/swagger (requires this server to be running).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddimaria%2Fkoa-typescript-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fddimaria%2Fkoa-typescript-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fddimaria%2Fkoa-typescript-starter/lists"}