UCSD-Team12 Web Component Library

Documentation Website

Unit Testing
Doc generation
Support Testing

Setup

To initialize this repo for development, please run

npm install

Once you have installed all the dependencies, you may want to transpile our webcomponents into es5 so that these component can be supported in older browsers. To do so run

We use clang-format for linting. If you are going to contribute please install clang-format. Below are some steps you can follow to install.

MacOS (install Homebrew):

$brew install clang-format

Windows please follow this guide

npm run build

Having issues?

Contribute

In order to contribute follow these steps:

1. Create a branch with a descriptive name. if you are working on a component name it and the branch "jj-{component name}"
2. Once finished with the ticket, push the commits to the branch.
3. Once all checks pass, create a pull request on github.
4. Once at least 2 people review and approve, squash and merge.

for a more information please read this guide

File Structure

The main code for all the components are in the 'packages' folder. All components contain:

1. demo folder, which holds the html that demos the component.
2. test folder, which holds a testcafe and unit tests.
3. a js file, which contains the core of the component.

The docs folder contains all of the documentation websites resources which includes the html, images, logos, js, css, etc.

The src folder contains minified version of our js files which the CDN points to.

The templates folder contains files that generate the website html files.

Unit Testing

To run all tests:
npm run test

Doc Generation

To generate docs:
npm run doc

Acknowledgement

We would like to thank SauceLabs for their support of open source projects like ours.