Typescript prototype

This package contains a simple sample of a Typescript package prototype. It is part of the educational repositories to learn how to write stardard code and common uses of the TDD.

See the documentation and how to do it on readthedocs. And see the development of this code step by step

• with see-git-steps

• on readthedocs / step by step

Installation

The package is not self-consistent: it needs to install npm, the Node Package Manager.

And then you can download the package by github:

$ git clone https://github.com/bilardi/typescript-prototype

Or you can install by npm:

$ npm install simple-sample

Usage

Read the unit tests in tests/myClass.test.py file to use it. This is a best practice.

import { MyClass } from 'simple-sample';
console.log(new MyClass(true));

Development

It is common use to test the code step by step and unittest module is a good beginning for unit test and functional test.

Test with unittest module

$ cd typescript-prototype
$ npm run test # see package.json for other details

Test all the other steps

$ cd typescript-prototype
$ make ptest # see Makefile for other details

Change Log

See CHANGELOG.md for details.

License

This package is released under the MIT license. See LICENSE for details.