Skip to content

stix2013/angular2-calendar

 
 

Repository files navigation

angular2 calendar

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

Please note this is currently a WIP and not yet finished, demos, npm installation will all 404 until the first release

Demo

https://mattlewis92.github.io/angular2-calendar/demo/

Table of contents

About

A calendar component that can display events on a month, week or day view. The successor of: https://github.com/mattlewis92/angular-bootstrap-calendar

Installation

Install through npm:

npm install --save angular2-calendar

For a full e2e example see the demo source. Better docs to follow in the future!

Usage without a module bundler

<script src="node_modules/angular2-calendar/angular2-calendar.js"></script>
<script>
    // everything is exported angular2Calendar namespace
</script>

Documentation

All documentation is auto-generated from the source via typedoc and can be viewed here: https://mattlewis92.github.io/angular2-calendar/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

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 85.9%
  • JavaScript 7.3%
  • CSS 5.1%
  • HTML 1.7%