0.0.5 • Published 8 years ago
sand-box v0.0.5
sand box
Demo
https://shameed.github.io/sand-box/
Table of contents
About
somthing
Installation
Install through npm:
npm install --save sand-box
Then include in your apps module:
import { NgModule } from '@angular/core';
import { SandBoxModule } from 'sand-box';
@NgModule({
imports: [
SandBoxModule.forRoot()
]
})
export class MyModule {}
Finally use in one of your apps components:
import { Component } from '@angular/core';
@Component({
template: '<hello-world></hello-world>'
})
export class MyComponent {}
You may also find it useful to view the demo source.
Usage without a module bundler
<script src="node_modules/sand-box/bundles/sand-box.umd.js"></script>
<script>
// everything is exported sandBox namespace
</script>
Documentation
All documentation is auto-generated from the source via compodoc and can be viewed here: https://shameed.github.io/sand-box/docs/
Development
Prepare your environment
- Install Node.js and NPM
- 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