pair14js v0.0.3

Team Pair a' Dice

Web Component Repository

Team Members

1. Stephanie Mitchener - Lead
2. Haozhi(Flik) Hu - Co-lead
3. Mingxun(Tyler) Song - Quality Assurance
4. Dung(Devon) Do - DevOps
5. Haimei Yang - DevOps
6. Eldon K. Y. Tay - Tool & Utility
7. Kent Thai - Coder
8. Alex Kurland - Coder
9. Axel Drozdzynski - Coder

Getting Started

1. Install Node.js
2. Download from the master branch
3. Open the directory and install dependencies
   • npm install

The Demo

1. Navigate to the demo/ folder
2. Run any of the demo HTML files in your favorite browser

The Web Components

1. We have core-hello, pair-switch, pair-slider, pair-button, core-color-picker, and more to come
2. All of the web component are located in lib/elements/
3. Access the individual JavaScript classes within the web component folders

Unit Testing

1. All Unit Tests are created with Jasmine, a JavaScript testing framework
2. They are all located in test/unit-test/
3. Access the individual Javascript unit tests within the web component folders
4. Run all unit tests:
   • ./node_modules/karma/bin/karma start --single-run
5. To update the existing test
   • read the Jasmine Documentation
6. To add a new test file
   • include a new folder in test/unit-test/
   • add a testing file within the new folder

Browser Testing

1. All browser tests are created with TestCafe, an end-to-end testing framework
2. They are all located in test/browser-test
3. Access the individual Javascript unit tests within the web component folders
4. Run individual browser test:
   • ./node_modules/.bin/testcafe chrome,firefox ./test/browser-test/ + web-component-folder/browser-test-file
   • To run locally, you will need to download the executable from the browsers you want to test on.
5. To update the existing test
   • read the TestCafe Documentation
6. To add a new test file,
   • include a new folder in test/browser-test/
   • add a testing file within the new folder

Travis CI

1. To run Travis CI, push your changes to GitHub on any of the branches
2. Open our Travis CI Build
3. If you added a new browser test
   • navigate to .travis.yml file
   • under scripts, include the command for running individual browser tests

Code Climate

1. To run Code Climate, push your changes to GitHub on any of the branches
2. If your build passes all of the tests on Travis CI, a snapshot of your code will be analyzed by Code Climate
3. Open our Code Climate Build

JSDoc

1. To be completed