Initial commit

.github/release.yml

@@ -0,0 +1,17 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+  categories:
+    - title: New Features 🦾
+      labels:
+        - new-feature
+    - title: Enhancements 🛠
+      labels:
+        - enhancement
+    - title: Bug Fixes 🔩
+      labels:
+        - bug
+    - title: Other 🗄
+      labels:
+        - "*"

.github/workflows/check_build.yml

@@ -0,0 +1,22 @@
+name: Build and check
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    if: github.event_name != 'push'
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Build
+        env:
+          NODE_OPTIONS: "--max_old_space_size=4096"
+        run: |
+          npm install
+          npm run build

.github/workflows/deploy_gh_pages.yml

@@ -0,0 +1,36 @@
+name: Build and deploy to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  gh-deploy:
+    if: github.event_name != 'pull_request' && !startsWith(github.ref, 'refs/tags/')
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Build component
+        env:
+          NODE_OPTIONS: "--max_old_space_size=4096"
+        run: |
+          npm install
+          npm run build
+      - name: Copy index and data files
+        run: |
+          cp ./src/public/index.html ./dist/index.html
+          cp ./src/public/assessment-data.yaml ./dist/assessment-data.yaml
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./dist
+          destination_dir: develop

.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release to GitHub Pages
+
+on:
+  push:
+    tags: ['*']
+
+jobs:
+  release:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+      - name: Build component
+        env:
+          NODE_OPTIONS: "--max_old_space_size=4096"
+        run: |
+          npm install
+          npm run build
+      - name: Copy index and data files
+        run: |
+          cp ./src/public/index.html ./dist/index.html
+          cp ./src/public/assessment-data.yaml ./dist/assessment-data.yaml
+      - name: Get tag name
+        id: get_tag_name
+        run: echo "TAG_NAME=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./dist
+          destination_dir: ${{ env.TAG_NAME }}

.gitignore

@@ -0,0 +1,27 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+/dist/
+
+/.idea/

README.md

@@ -0,0 +1,74 @@
+# PKI Maturity Model Self-Assessment Web Component
+
+This is a web component that allows users to self-assess their organization's PKI maturity level. The component is based on the [PKI Maturity Model](https://pkic.org/pkimm/) developed by the [PKI Consortium](https://pkic.org/).
+
+## Quick Start
+
+To use the component, include the following script in your HTML file. Replace `<version>` with the version number you want to use.
+
+```html
+<script src="https://pkic.github.io/self-assessment/<version>/bundle.js"></script>
+```
+
+Then, add the `<self-assessment>` tag to your HTML file.
+
+```html
+<self-assessment dataurl="https://pkic.github.io/self-assessment/<version>/assessment-data.yaml"></self-assessment>
+```
+
+## Development
+
+Install the dependencies by running the following command:
+
+```bash
+npm install
+```
+
+Build the component by running the following command:
+
+```bash
+npm run build
+```
+
+To start the development server, run the following command:
+
+```bash
+npm run start
+```
+
+The development server will be available at `http://localhost:9000`. You can use [`index.html`](src/public/index.html) and [`assessment-data.yaml`](src/public/assessment-data.yaml) in the [`src/public`](src/public) directory to test the component.
+
+## Customization
+
+You can customize the styles of the component by adding the following CSS to your HTML file. Default values are shown below. See [`index.module.scss`](src/components/index.module.scss) for more details.
+
+```css
+:root {
+  --pkimm-primary-color: #{$primary-color};
+  --pkimm-secondary-color: #{$secondary-color};
+  --pkimm-tertiary-color: #{$tertiary-color};
+
+  --pkimm-primary-color-hover: #{$primary-color-hover};
+  --pkimm-primary-color-lighter: #{$primary-color-lighter};
+
+  --pkimm-secondary-color-lighter: #{$secondary-color-lighter};
+
+  --pkimm-maturity-level-1: #{$maturity-level-1};
+  --pkimm-maturity-level-2: #{$maturity-level-2};
+  --pkimm-maturity-level-3: #{$maturity-level-3};
+  --pkimm-maturity-level-4: #{$maturity-level-4};
+  --pkimm-maturity-level-5: #{$maturity-level-5};
+
+  --pkimm-background-color: #{$background-color};
+
+  --pkimm-text-color-dark: #{$text-color-dark};
+  --pkimm-text-color-light: #{$text-color-light};
+
+  --pkimm-sticky-top-offset: 0px;
+  --pkimm-scroll-query-selector: window;
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.