Merge branch 'develop'

.eslintrc.json

@@ -15,13 +15,15 @@
     "ecmaVersion": 11,
     "sourceType": "module"
   },
-  "ignorePatterns": ["/dist", "/dist-web"],
+  "ignorePatterns": ["/dist", "/dist-web", "*.d.ts"],
   "rules": {
     "prettier/prettier": "error",
     "indent": "off",
     "linebreak-style": ["error", "unix"],
     "quotes": ["error", "double", "avoid-escape"],
     "semi": ["error", "always"],
+    "vue/multi-word-component-names": "off",
+    "vue/no-reserved-component-names": "off",
     "vue/order-in-components": [
       "error",
       {

.github/workflows/main.yml

@@ -7,72 +7,74 @@ env:
 
 jobs:
   publish:
-    runs-on: self-hosted
+    runs-on: [self-hosted, common]
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: '16'
-      - uses: actions/setup-python@v2
+          node-version: "18"
+          check-latest: true
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
       - name: Setup npm
         run: npm install npm@latest -g
       - run: npm ci
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.REPOS_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }} 
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npm run semantic-release
+
   build-and-push:
-    runs-on: self-hosted
+    runs-on: [self-hosted, common]
     if: contains('
-          refs/heads/develop
-          refs/heads/master
-          refs/heads/main'
-        , github.ref)
+      refs/heads/develop
+      refs/heads/master
+      refs/heads/main'
+      , github.ref)
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Login to BIMData Docker Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: docker-registry.bimdata.io
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASS }}
       - id: tag
         name: Get docker tag
-        uses: bimdata/actions/get-docker-tag@v1
+        uses: bimdata/actions/get-docker-tag@v2
         with:
           branch: ${{ github.ref }}
       - name: Build and push
-        uses: docker/build-push-action@v2
+        uses: docker/build-push-action@v4
         with:
           context: .
           file: etc/Dockerfile
           push: true
           pull: true
           tags: |
             docker-registry.bimdata.io/bimdata/${{ env.app }}:${{ github.sha }}
-            docker-registry.bimdata.io/bimdata/${{ env.app }}:${{ steps.tag.outputs.tag }}
-  
+            docker-registry.bimdata.io/bimdata/${{ env.app }}:${{ env.tag }}
+
   deploy:
-    runs-on: self-hosted
+    runs-on: [self-hosted, common]
     needs: build-and-push
     steps:
       - name: Login to BIMData Docker Registry
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           registry: docker-registry.bimdata.io
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASS }}
       - id: tag
         name: Get docker tag
-        uses: bimdata/actions/get-docker-tag@v1
+        uses: bimdata/actions/get-docker-tag@v2
         with:
           branch: ${{ github.ref }}
-      - name: Deploy on ${{ steps.tag.outputs.tag }}
-        uses: bimdata/actions/deployment@v1
+      - name: Deploy on ${{ env.tag }}
+        uses: bimdata/actions/deployment@v2
         with:
-          inventory: ${{ steps.tag.outputs.tag }}
+          inventory: ${{ env.tag }}
           app: ${{ env.app }}
           vault-pass: ${{ secrets.ANSIBLE_VAULT_PASSWD }}
-
-

.gitignore

@@ -1,7 +1,6 @@
 .DS_Store
 node_modules
 dist
-dist-web
 
 # local env files
 .env.local

.npmignore

@@ -1,5 +1,2 @@
-# ignore design system folder
+# ignore design system app files
 src/web/
-
-# ignore main.js of design system
-src/main.js

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 BIMData.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,16 +1,16 @@
 # BIMData Design System
 
-> BIMData's Design System is an open-source DS. The documentation is available at this url: [design.bimdata.io](https://design.bimdata.io/)
+> BIMData's Design System is an open-source DS. The documentation is available here: [design.bimdata.io](https://design.bimdata.io/)
 
 <p align="center">
-  <img src="./screenshots/design-system_illustration.png" alt="Design system illustration" />
+  <img src="./design-system.png" alt="BIMData Design System" />
 </p>
 
 ## Used by
 
 - [BIMData Viewer](https://www.npmjs.com/package/@bimdata/viewer)
 - [BIMData Viewer SDK](https://github.com/bimdata/bimdata-viewer-sdk)
-- BIMData Marketplace (coming soon..)
+- [BIMData Marketplace](https://marketplace.bimdata.io/)
 - [BIMData Platform](https://platform.bimdata.io)
 
 ## :runner: Getting started
@@ -21,7 +21,7 @@ npm i @bimdata/design-system
 
 ## :raising_hand: Compatibility
 
-BIMData Design System is a library compatible with Vue 2 and Vue 3.
+BIMData Design System is a library compatible with Vue 3.
 
 ## :open_hands: Contributing
 
@@ -37,14 +37,8 @@ npm install
 ### Compiles and hot-reloads for development
 npm run dev
 
-### Compiles and minifies for production
-npm run build
-
 ### Run your tests
 npm run test
-
-### Lints and fixes files
-npm run lint
 ```
 
 ## :package: Publish / :rocket: Deploy
@@ -94,3 +88,7 @@ The branches on which it is possible to publish are the following:
 
 For Merging this branches together, and to avoid any unexpected behavior, use `--no-ff` git merge option.
 After deploying a new latest tag with master branch, merge master into develop to update `package.json` and `CHANGELOG.md`.
+
+## License
+
+BIMData Design System is published under the term of MIT License (see [LICENSE](./LICENSE)).

etc/Dockerfile

@@ -13,4 +13,4 @@ RUN npm run build-web
 FROM nginx:stable
 RUN rm /etc/nginx/conf.d/default.conf
 COPY etc/nginx.conf /etc/nginx/conf.d/default.conf
-COPY --from=0 /opt/dist-web /usr/share/nginx/html
+COPY --from=0 /opt/dist /usr/share/nginx/html

index.html

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <link rel="icon" href="/favicon.ico" />
+    <title>Design System</title>
+
+    <script type="module" src="/src/web/main.js"></script>
+  </head>
+  <body>
+    <noscript>
+      <strong>
+        We're sorry but the Design System doc doesn't work properly without JavaScript enabled.
+        Please enable it to continue.
+      </strong>
+    </noscript>
+    <div id="app"></div>
+  </body>
+</html>