Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geometryzen/typescript-modular-boilerplate

TypeScript library boilerplate using external modules.
https://github.com/geometryzen/typescript-modular-boilerplate

Last synced: 9 days ago
JSON representation

TypeScript library boilerplate using external modules.

Awesome Lists containing this project

README

        

# Welcome to TypeScript Modular Boilerplate

Work in TypeScript, generate JavaScript and requirejs modules.

(An example project using TypeScript that compiles to AMD and CommonJS).

[![Build Status](https://travis-ci.org/geometryzen/typescript-modular-boilerplate.png)](https://travis-ci.org/geometryzen/typescript-modular-boilerplate)

## Contributing

### Building

Open your Terminal.

Clone the typescript-modular-boilerplate repo.
```
git clone git://github.com/geometryzen/typescript-modular-boilerplate.git
```

Change to the repo directory.
```
cd typescript-modular-boilerplate
```

Run
```
npm install
```
to install the tooling dependencies (For this you need to have [Node.js](http://nodejs.org) installed).

Run
```
bower install
```
to install the software dependencies (For this you need to have [Bower](http://bower.io) installed).

Run
```
grunt
```
to package the individual files into a single JavaScript file.

### Making Changes
Make your changes to the TypeScript files in the _src_ directory. Do not edit the files in the _dist_ directory, these files will be generated.

## Release History
* v0.1.0: Initial release (pending)

## License
Copyright (c) 2014-2015 David Holmes
Licensed under the MIT license.