ft-interactive/koa2-typescript-boilerplate

Name: koa2-typescript-boilerplate

Owner: FT Interactive News

Description: Koa2 boilerplate using TypeScript

Created: 2016-07-21 17:23:11.0

Updated: 2018-01-06 04:04:26.0

Pushed: 2016-11-18 12:53:32.0

Homepage: null

Size: 29

Language: TypeScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Koa 2 TypeScript boilerplate

This is a quick boilerplate instructing how configure TypeScript to work with Koa et al.

To use:

1. Clone:

   $ git clone https://github.com/ft-interactive/koa2-typescript-boilerplate.git

2. npm install:

   $ cd koa2-typescript-boilerplate && npm install

   This will also install the TypeScript definitions used in this project.

3. To run the development server, run:

   $ npm run dev-server

   This uses ts-node to transpile on-the-fly and probably ain't the best idea for production.

4. To build for production, run:

   $ npm run build

   … Which can then be started with:

   $ npm start

   Included is a Procfile that will do this for you on Heroku.

ToDo:

• [ ] Add some basic SuperTest integration tests
• [ ] Add an example using koa-views or somesuch
• [ ] Write some example middleware showcasing async/await hawtness