https://github.com/donkeycode/donkeycode-angular2-tools
Lots of things for Angular 2 -
https://github.com/donkeycode/donkeycode-angular2-tools
Last synced: 6 months ago
JSON representation
Lots of things for Angular 2 -
- Host: GitHub
- URL: https://github.com/donkeycode/donkeycode-angular2-tools
- Owner: donkeycode
- License: mit
- Created: 2016-08-25T12:10:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-09-22T10:57:12.000Z (over 9 years ago)
- Last Synced: 2025-06-17T16:46:13.719Z (7 months ago)
- Language: TypeScript
- Homepage: https://donkeycode.github.io/donkeycode-angular2-tools
- Size: 108 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## 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.