oro-sample-module
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

sample module

Build Status npm version devDependency Status GitHub issues GitHub stars GitHub license

Demo

https://icg.github.io/sample-module/demo/

Table of contents

About

Installation

Install through npm:

npm install --save sample-module

Then use it in your app like so:

import {Component} from '@angular/core';
import {HelloWorld} from 'sample-module';
 
@Component({
  selector: 'demo-app',
  directives: [HelloWorld],
  template: '<hello-world></hello-world>'
})
export class DemoApp {}

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/dist/umd/sample-module/sample-module.js"></script>
<script>
    // everything is exported sampleModule namespace
</script>

Documentation

All documentation is auto-generated from the source via typedoc and can be viewed here: https://icg.github.io/sample-module/docs/

Development

Prepare your environment

  • Install Node.js and NPM (should come with)
  • Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

  • Bump the version in package.json (once the module hits 1.0 this will become automatic)
npm run release

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i oro-sample-module

Weekly Downloads

0

Version

0.0.2

License

MIT

Last publish

Collaborators

  • morobitg