Component Template

This is a template for creating a new component. It includes a basic structure for the component, as well as a set of scripts for building, testing, and documenting the component.

Getting Started

To create a new component, you can use this template as a starting point. To do so, click the "Use this template" button at the top of the repository page. This will create a new repository with the same structure as this one.

Once you have created a new repository, you can clone it to your local machine and start working on your component.

git clone

Install Dependencies

1. Before creating a new component, first install the dependencies:

npm install

2. Then run the test to ensure everything is in working order:

npm test

note: a coverage and test report will be generated in the coverage directory and report directory, respectively.

3. Finally, run the document script to generate the component API documentation:

npm run document

note: The API documentation will be generated in the docs directory. You can review this by opening the index.html file in the docs directory in a web browser.

Creating a New Component

To create a new component, you should first update the package metadata:

Update Package Metadata

Update the package name across all relevant files in this project:

1. Specifications: update name and add package metadata in the component.specifications.json file in the specifications directory.

2. Package: package.json in the root directory.

3. Typescript Config: both tsconfig.json files are in the root directory.

4. ES Module: importmap.js files in the importmap directory.

5. Component: update the file names in src folder and class name.

6. Unit Testing: The wallaby.js and karma.conf.js files are in the root directory, the file names and the package name used in unit tests: test/unit

7. Demo: The index.js file in the demo directory.

8. Confirm that the component name has been updated in all relevant files by running the test script:

npm test

Creating a New Component

To create a new component:

1. Review the directory and file structure of the fake component implementation.
2. Study this software architecture implementation policies (available from repository owner).
3. Define the component specifications using the component.specifications.json template file provided.
4. Stickly follow a TDD development approach in feature branches.
5. After complete implementation of a feature, test, build, and generate the documentation (see below)
6. Update the demo scaffold in the demo directory to reflect the new component's API and functionality.
7. Lastly do a pull request to the main branch and merge it if everything checks out.

Testing the Component

To test the component, you can use the test script. This script will run the component's test suite and generate both a test and coverage report.

npm test

Document the Component API

To document the component API, you can use the docs script. This script will generate a set of documentation files for the component.

npm run document

License

This software and its documentation are released under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License (CC BY-NC-SA 4.0). This means you are free to share, copy, distribute, and transmit the work, and to adapt it, but only under the following conditions:

Attribution: You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).

NonCommercial: You may not use this material for commercial purposes.

ShareAlike: If you alter, transform, or build upon this work, you may distribute the resulting work only under the same or similar license to this one.

For more details, please visit the full license agreement.