0.1.2 • Published 10 years ago

donkeycode-angular2-tools v0.1.2

Weekly downloads
-
License
MIT
Repository
-
Last release
10 years ago

DonkeyCode Angular2 tools

DonkeyCode offers a set of tools for developing with Angular 2 : spinner, default image for example.

Have fun :heart: :heart: :heart: !!

See full documentation : https://donkeycode.github.io/donkeycode-angular2-tools

Contributing Guide

Contributing to donkeycode-angular2-tools is fairly easy. This document shows you how to get the project, run all provided tests and generate a production ready build.

Dependencies

To make sure, that the following instructions work, please install the following dependencies on you machine:

  • Node.js
  • npm
  • Git

Installation

To get the source of donkeycode-angular2-tools clone the git repository via:

git clone https://github.com/donkeycode/donkeycode-angular2-tools

This will clone the complete source to your local machine. Navigate to the project folder and install all needed dependencies via npm:

npm install

Finally, install the required typescript definitions:

npm run install_typings

Well done! donkeycode-angular2-tools is now installed and ready to be built.

If you add an new component, service or directive, don't forget to add file on tsconfig.json.

{
  "version": "1.8.10",
  "compilerOptions": {
    "noImplicitAny": true,
    "module": "commonjs",
    "target": "es5",
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "sourceMap": true,
    "declaration": true,
    "outDir": "dist"
  },
  "files": [
    "typings/index.d.ts",
    "src/index.ts",
    "src/directives/default-image.directive.ts",
    "YOUR/FILE.HERE"
  ]
}

Documentation

We love documentation and we want documentation. Also, We work with typedoc ===> http://typedoc.org/guides/doccomments/

Then, after to create your magic component, thanks to add annotations and run npm run generate-doc.

As if by magic, you can see your doc on https://donkeycode.github.io/donkeycode-angular2-tools !

Building

donkeycode-angular2-tools comes with a few npm scripts which help you to automate the development process.

0.1.2

10 years ago

0.1.1

10 years ago

0.1.0

10 years ago

0.0.10

10 years ago

0.0.9

10 years ago

0.0.8

10 years ago

0.0.7

10 years ago

0.0.6

10 years ago

0.0.5

10 years ago

0.0.4

10 years ago

0.0.3

10 years ago

0.0.2

10 years ago

0.0.1

10 years ago