A starter repository for Kendo UI Angular components, which provides the basic directory structure and dependencies.
WARNING: the current test setup is extremely brittle and (mostly) based on the AngularClass starter repository. There are several very ugly things, we hope that these will be gradually cleared as the framework matures.
WARNING: After cloning the repo and running
npm install, run
npm run typings.
srcdirectory contains the component source code. All files should have the
.tsextensions so that the build scripts may pick them.
src/main.tsfile should import and re-export all public components of the package. It is used for the
build-cdntask. It is also the main entry point for the NPM package (as specified by the
build-npm-packagetranspiles it to
src/kendo-component.tsfile is the actual sample component implementation.
src/util.tsis an optional example of an additional file - you may remove it if unnecessary.
examplesdirectory hosts the demos for the component. As a bare minimum, the component should have a
basic usageand a
CDNexample should work as expected after the
build-cdntask has been run.
testdirectory contains the component tests. They are transpiled just like the source code itself, and run with Jasmine in Karma (PhantomJS).
e2edirectory contains the end-to-end tests. They are transpiled and run with Jasmine in Karma (Google Chrome).
docsdirectory contains markdown files that document the specifics of the component.
- Fork the repository to an appropriately named new one;
- Change the package name/description in
package.json; change the reference to the theme package;
- Change the library name in
- Change the
src/kendo-component.tsfile name to something more meaningful;
- Delete the current contents and put something nice in
build-npm-package- builds the scripts and styles in
dist/npmin CommonJS format;
build-cdn- builds the scripts and styles in
dist/cdnin UMD format.
start- starts the webpack-dev-server (with browsersync in front of it) - suitable for example preview, development and testing.
test- runs the tests with Jasmine in Karma/PhantomJS.
watch-test- runs the tests in watch mode.
e2e- runs the
e2etests with Jasmine in Karma/Google Chrome.