ngx-scheduler
v0.0.0
Published
A reusable scheduler library for Angular
Downloads
12
Maintainers
Readme
ngx scheduler
Demo
https://FlexWilliams.github.io/ngx-scheduler/
Table of contents
About
A reusable scheduler library for Angular
Installation
Install through npm:
npm install --save ngx-scheduler
Then include in your apps module:
import { NgModule } from '@angular/core';
import { NgxSchedulerModule } from 'ngx-scheduler';
@NgModule({
imports: [
NgxSchedulerModule.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/ngx-scheduler/bundles/ngx-scheduler.umd.js"></script>
<script>
// everything is exported ngxScheduler namespace
</script>
Documentation
All documentation is auto-generated from the source via compodoc and can be viewed here: https://FlexWilliams.github.io/ngx-scheduler/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