Project Title

BCC Calendar AngularJS module. This package is to create a calendar that can be used in Bootcampers Collective projects.

Using in your application

To use the bcc-calendar component in your application begin by installing it into your package.json using either NPM or Yarn.

prompt> $ npm install bcc-calendar -save

prompt> $ yarn add bcc-calendar --save

You will also need to install moment.js using the same method as above.

prompt> $ npm install moment -save

prompt> $ yarn add moment --save

In your angular module define the bcc-calendar as a dependency.

angular.module('app', ['bcc-calendar'])

To invoke the component, use it in your HTML as follows.

<div>
    <bcc-calendar data="{{$ctrl.data}}"></bcc-calendar>
</div>

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You will need to install node (at least v6) Mac installation (brew):

brew install node

PC installation:

You will need to install yarn Mac installation (brew):

brew install yarn

PC installation:

You will need to install gulp Mac installation (brew):

yarn add gulp --global

PC installation:

Installing

Once everything has been installed, to get your development environment running:

First install the prerequisites from yarn.

prompt> $ yarn

You should see this returned:

yarn install v0.27.5
warning ../../../package.json: No license field
[1/4] Resolving packages...
[2/4] Fetching packages...
[3/4] Linking dependencies...
[4/4] Building fresh packages...
Done in 4.35s.

run gulp

prompt> $ gulp

You should see this returned:

[17:10:14] Using gulpfile ~/websites/bcc/bcc-calendar/gulpfile.js
[17:10:14] Starting 'dev:clean'...
[17:10:14] Finished 'dev:clean' after 4.44 ms
[17:10:14] Starting 'lint'...
[17:10:14] Starting 'dev:vendor'...
[17:10:14] Starting 'dev:scripts'...
[17:10:14] Starting 'dev:styles'...
[17:10:14] Starting 'serve'...
[17:10:14] Webserver started at http://localhost:8000
[17:10:14] Finished 'serve' after 10 ms
[17:10:14] Starting 'watch'...
---Starting Watch task---
[17:10:14] Finished 'watch' after 20 ms
[17:10:14] Finished 'lint' after 553 ms
[17:10:14] /Users/wsong/websites/bcc/bcc-calendar/dev/scripts/bcc-calendar.min.js reloaded.
[17:10:14] Finished 'dev:scripts' after 546 ms
[17:10:14] /Users/wsong/websites/bcc/bcc-calendar/dev/styles/bcc-calendar.css reloaded.
[17:10:14] Finished 'dev:styles' after 549 ms
[17:10:19] Finished 'dev:vendor' after 5.17 s
[17:10:19] Starting 'default'...
---Starting Default task---
[17:10:19] Finished 'default' after 33 μs

That should be it, open up your favorite browser and go to http://localhost:8000 and see if you see the test page.

Build

If you are building this to publish to a private NPM or as a custom package:

prompt> $ gulp dist

Built With

• AngularJS - The web framework used
• Gulp - Dependency Management
• SASS - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Wesley Song - Initial work - PurpleBooth

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

• Bootcampers Collective
• The AngularJS people for building such a useful framework