Skip to content

A typescript boilerplate for building javascript libraries for both node and browsers.

License

Notifications You must be signed in to change notification settings

friends-of-js/typescript-module-starter-kit

Repository files navigation

Typescript module starter kit

A damn simple es5, es7 and Typescript starter kit for creating node modules and browser bundles using webpack for packaging.

Getting started

git clone git@github.com:friends-of-js/typescript-module-starter-kit.git
cd typescript-module-starter-kit
yarn install

You should change package name in package.json

Commands

you can see a list of all available commands with description by typing in the console

yarn h

or

yarn i

Project structure

Name Description
src Your source files placed here
spec Contains your tests files
node_modules Contains all your npm dependencies
build Scripts that responsible for building package
build/declarations Typescript declarations for packages that does not provide declarations
lib Generated package
lib/browser Browser bundle that can be directly used in browser
lib/module Node module packages
lib/module/commonjs Commonjs node module using es5 features
lib/module/esnext Node module using es7 and esnext features
coverage Code coverage report files
tools Tools for publication release and github pages
tsconfig.json Main typescript configuration file
tslint.json Main tslint configuration file

Releases

No releases published

Packages

No packages published