Merge pull request #976 from basics/feature/renaming-main

Feature/renaming main

Author: ThornWalli

.eslintignore

@@ -9,5 +9,5 @@ sw.js
 .output
 
 src/runtime/tmpl/**/*
-src/runtime/components/SpeedkitLayer.vue
+src/runtime/components/BoosterLayer.vue
 src/supportedBrowserDetector.mjs

.github/FUNDING.yml

@@ -2,7 +2,7 @@
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
 patreon: # Replace with a single Patreon username
-open_collective: nuxt-speedkit
+open_collective: nuxt-booster
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry

.github/workflows/sonar-cloud.yml

@@ -52,8 +52,8 @@ jobs:
         uses: sonarsource/sonarcloud-github-action@master
         with:
           args: >
-            -Dsonar.organization=grabarzundpartner
-            -Dsonar.projectKey=GrabarzUndPartner_nuxt-speedkit
+            -Dsonar.organization=basics
+            -Dsonar.projectKey=basics_nuxt-booster
             -Dsonar.eslint.reportPaths=eslint-report.json
             -Dsonar.projectVersion=${{ steps.package-version.outputs.current-version}}
         env:

.mailmap

@@ -1,4 +1,4 @@
 Renovate Bot <[email protected]>
-StephanGerbeth <[email protected]> Stephan Gerbeth <[email protected]>
-Thorn Walli <[email protected]> Thorn Walli <[email protected]>
+StephanGerbeth <[email protected]>
+Thorn Walli <[email protected]>
 semantic-release-bot <[email protected]>

CHANGELOG.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
+reported by contacting the project team at <[email protected]>. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -68,9 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+<https://www.contributor-covenant.org/faq>

CODE_OF_CONDUCT.md

@@ -1,4 +1,5 @@
-# Contributing to Nuxt-Speedkit
+# Contributing to Nuxt-Booster
+
 We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
 
 - Reporting a bug
@@ -8,9 +9,11 @@ We love your input! We want to make contributing to this project as easy and tra
 - Becoming a maintainer
 
 ## We Develop with Github
+
 We use github to host code, to track issues and feature requests, as well as accept pull requests.
 
 ## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
+
 Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
 
 1. Fork the repo and create your branch from `master`.
@@ -21,12 +24,15 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu
 6. Issue that pull request!
 
 ## Any contributions you make will be under the MIT Software License
+
 In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
 
-## Report bugs using Github's [issues](https://github.com/GrabarzUndPartner/nuxt-speedkit/issues)
-We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/GrabarzUndPartner/nuxt-speedkit/issues/new/choose); it's that easy!
+## Report bugs using Github's [issues](https://github.com/basics/nuxt-booster/issues)
+
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/basics/nuxt-booster/issues/new/choose); it's that easy!
 
 ## Write bug reports with detail, background, and sample code
+
 **Great Bug Reports** tend to have:
 
 - A quick summary and/or background
@@ -40,7 +46,9 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
 People *love* thorough bug reports. I'm not even kidding.
 
 ## License
+
 By contributing, you agree that your contributions will be licensed under its MIT License.
 
 ## References
+
 This document was adapted from the open-source contribution guidelines from [Brian A. Danielak](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Grabarz & Partner Werbeagentur GmbH
+Copyright (c) 2024 basics
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,11 +1,18 @@
+> # 🚨 Please update your dependencies. You can still retrieve version 2 (`nuxt-booster@2`), but it will no longer be maintained
 
-> # <span style="color: red;">**Important**</span><br> 🚨 `nuxt-speedkit` becomes `nuxt-booster` with full Nuxt 3 support. Please update your dependencies. You can still retrieve version 2 (`nuxt-booster@2`), but it will no longer be maintained
+# Nuxt Booster
 
-# Nuxt Speedkit
-
-Nuxt Speedkit takes over the Lighthouse performance optimization of your generated website.
+Nuxt Booster takes over the Lighthouse performance optimization of your generated website.
 All used components and resources are loaded on demand based on the viewport.
 
+## Demos
+
+- [Nuxt Booster Example](https://basics.github.io/nuxt-booster/playground/) ([Lighthouse](https://pagespeed.web.dev/report?url=https%3A%2F%2Fbasics.github.io%2Fnuxt-booster%2Fplayground%2F), [Sitespeed](https://basics.github.io/nuxt-booster/reports/sitespeed/nuxt-booster/))
+
+## Getting Started
+
+Please follow the [📖 &nbsp;&nbsp;**Documentation**](https://basics.github.io/nuxt-booster/)
+
 ## Requirements
 
 - NodeJS `>= 12.x.x`
@@ -29,11 +36,11 @@ All used components and resources are loaded on demand based on the viewport.
 - delivery of the minimum required resources based on the current viewport
 - if you use the tools as specified you will get a lighthouse performance score of 100/100
 
-📖 &nbsp;&nbsp;[Read more](https://nuxt-speedkit.grabarzundpartner.dev/)
+📖 &nbsp;&nbsp;[Read more](https://basics.github.io/nuxt-booster/)
 
 ## Browsers support
 
-> You can use `nuxt-speedkit` with **Internet Explorer 11** browser. [Learn more at Browser compatibility](https://nuxt-speedkit.grabarzundpartner.dev/caveats#browser-compatibility)
+> You can use `nuxt-booster` with **Internet Explorer 11** browser. [Learn more at Browser compatibility](https://basics.github.io/nuxt-booster/caveats#browser-compatibility)
 
 | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>IE / Edge | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari-ios/safari-ios_48x48.png" alt="iOS Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>iOS Safari | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/samsung-internet/samsung-internet_48x48.png" alt="Samsung" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Samsung | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Opera | [<img src="https://raw.githubusercontent.com/alrra/browser-logos/master/src/vivaldi/vivaldi_48x48.png" alt="Vivaldi" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Vivaldi |
 | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -52,6 +59,10 @@ All used components and resources are loaded on demand based on the viewport.
 3. Build and start with express `npm run start:generate` or `yarn start:generate`.
 4. Open [http://127.0.0.1:3000](http://127.0.0.1:3000) in Browser.
 
+## Consulting & Support
+
+Do you need further support, a consultation or a code review for an appropriate fee? Just contact us via eMail: <[email protected]>. We are looking forward to your request.
+
 ## License
 
 [MIT License](./LICENSE)

README.md

@@ -8,10 +8,10 @@
     "sourceMap": true,
     "baseUrl": ".",
     "paths": {
-      "nuxt-speedkit/*": [
+      "nuxt-booster/*": [
         "src/runtime/*"
       ],
-      "#speedkit": [
+      "#booster": [
         "src/runtime/*"
       ],
       "@/*": [

jsconfig.json

@@ -59,7 +59,7 @@
     },
     "javascript.format.enable": false,
     "path-intellisense.mappings": {
-      "nuxt-speedkit": "${workspaceRoot}/src/runtime",
+      "nuxt-booster": "${workspaceRoot}/src/runtime",
       "@": "${workspaceRoot}/playground",
       "@@": "${workspaceRoot}"
     },

nuxt-speedkit.code-workspace renamed to nuxt-booster.code-workspace

@@ -1,7 +1,7 @@
 {
-  "name": "nuxt-speedkit",
+  "name": "nuxt-booster",
   "version": "2.2.9",
-  "description": "Nuxt Speedkit takes over the Lighthouse performance optimization of your generated website.",
+  "description": "Nuxt Booster takes over the Lighthouse performance optimization of your generated website.",
   "license": "MIT",
   "contributors": [
     {
@@ -15,7 +15,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/GrabarzUndPartner/nuxt-speedkit"
+    "url": "https://github.com/basics/nuxt-booster"
   },
   "scripts": {
     "build:bundle": "esbuild src/runtime/tmpl/supportedBrowserDetector.mjs --platform=node --bundle --outfile=src/supportedBrowserDetector.mjs --external:browserslist --external:argue-cli --external:easy-table --external:picocolors",

package-lock.json

@@ -1,41 +1,41 @@
 <template>
-  <speedkit-layer class="info-layer" v-bind="$attrs" v-on="$listeners">
+  <booster-layer class="info-layer" v-bind="$attrs" v-on="$listeners">
     <div>
       <p v-font="$getFont('Quicksand', 400, 'normal')">
         Sorry, but you will have a limited user experience due to a…
       </p>
       <ul v-font="$getFont('Quicksand', 700, 'normal')">
-        <li id="nuxt-speedkit-message-nojs">disabled javascript</li>
-        <li id="nuxt-speedkit-message-unsupported-browser">outdated browser</li>
-        <li id="nuxt-speedkit-message-reduced-bandwidth">reduced-bandwidth</li>
-        <li id="nuxt-speedkit-message-weak-hardware">weak hardware</li>
+        <li id="nuxt-booster-message-nojs">disabled javascript</li>
+        <li id="nuxt-booster-message-unsupported-browser">outdated browser</li>
+        <li id="nuxt-booster-message-reduced-bandwidth">reduced-bandwidth</li>
+        <li id="nuxt-booster-message-weak-hardware">weak hardware</li>
       </ul>
       <div class="info-layer-buttons">
-        <base-button id="nuxt-speedkit-button-init-nojs">
-          <label for="nuxt-speedkit-layer-close"> Yes </label>
+        <base-button id="nuxt-booster-button-init-nojs">
+          <label for="nuxt-booster-layer-close"> Yes </label>
         </base-button>
-        <base-button id="nuxt-speedkit-button-init-reduced-view">
-          <label for="nuxt-speedkit-layer-close"> No </label>
+        <base-button id="nuxt-booster-button-init-reduced-view">
+          <label for="nuxt-booster-layer-close"> No </label>
         </base-button>
-        <base-button id="nuxt-speedkit-button-init-app" label="Yes" />
+        <base-button id="nuxt-booster-button-init-app" label="Yes" />
       </div>
     </div>
-  </speedkit-layer>
+  </booster-layer>
 </template>
 
 <script>
-import { getStyleDescription } from '#speedkit/utils/description';
-import SpeedkitLayer from '#speedkit/components/SpeedkitLayer';
+import { getStyleDescription } from '#booster/utils/description';
+import BoosterLayer from '#booster/components/BoosterLayer';
 import BaseButton from '@/components/atoms/BaseButton';
 
 export default {
   components: {
     BaseButton,
-    SpeedkitLayer
+    BoosterLayer
   },
   inheritAttrs: false,
   head() {
-    return this.$speedkit.head({
+    return this.$booster.head({
       noscript: [
         getStyleDescription(
           '.info-layer > div { animation-delay: initial !important; }',
@@ -50,7 +50,7 @@ export default {
 
 <style lang="postcss" scoped>
 .info-layer {
-  & :deep(#nuxt-speedkit-layer-content) {
+  & :deep(#nuxt-booster-layer-content) {
     position: fixed;
     top: 0;
     left: 0;
@@ -79,8 +79,8 @@ export default {
     }
   }
 
-  &.nuxt-speedkit-layer-visible {
-    & :deep(#nuxt-speedkit-layer-content) {
+  &.nuxt-booster-layer-visible {
+    & :deep(#nuxt-booster-layer-content) {
       animation-delay: initial;
     }
   }

package.json

@@ -10,7 +10,7 @@
       ]"
     >
       <div class="image">
-        <speedkit-picture
+        <booster-picture
           :title="picture.title"
           :alt="picture.alt"
           :sources="picture.sources"
@@ -26,11 +26,11 @@
 </template>
 
 <script>
-import SpeedkitPicture from '#speedkit/components/SpeedkitPicture';
+import BoosterPicture from '#booster/components/BoosterPicture';
 
 export default {
   components: {
-    SpeedkitPicture
+    BoosterPicture
   },
   props: {
     alignRight: { type: Boolean, default: false },

playground/components/InfoLayer.vue

@@ -1,6 +1,6 @@
 <template>
   <document-section class="component-stage" :level="-1">
-    <speedkit-picture
+    <booster-picture
       class="background"
       :title="picture.title"
       :alt="picture.alt"
@@ -24,19 +24,19 @@
       <span v-if="ready" class="arrow"><svg-chevron-down /></span>
     </transition>
 
-    <speedkit-image class="logo" v-bind="image" :loading-spinner="null" />
+    <booster-image class="logo" v-bind="image" :loading-spinner="null" />
   </document-section>
 </template>
 
 <script>
-import SpeedkitPicture from '#speedkit/components/SpeedkitPicture';
-import SpeedkitImage from '#speedkit/components/SpeedkitImage';
+import BoosterPicture from '#booster/components/BoosterPicture';
+import BoosterImage from '#booster/components/BoosterImage';
 import SvgChevronDown from '@/assets/svg/chevron-down.svg?vue-template';
 
 export default {
   components: {
-    SpeedkitPicture,
-    SpeedkitImage,
+    BoosterPicture,
+    BoosterImage,
     SvgChevronDown
   },
 
@@ -158,9 +158,9 @@ export default {
       position: absolute;
       top: 0;
       left: 0;
-      object-fit: cover;
       width: 100%;
       height: 100%;
+      object-fit: cover;
     }
   }
 

playground/components/organisms/ImageText.vue

@@ -3,19 +3,19 @@
     v-font="[$getFont('Merriweather', 400)]"
     class="video-vimeo"
   >
-    <speedkit-vimeo v-bind="$attrs">
+    <booster-vimeo v-bind="$attrs">
       <template #default="{ videoData }">
         <div class="description" v-html="videoData && videoData.description" />
       </template>
-    </speedkit-vimeo>
+    </booster-vimeo>
   </document-section>
 </template>
 
 <script>
-import SpeedkitVimeo from '#speedkit/components/SpeedkitVimeo';
+import BoosterVimeo from '#booster/components/BoosterVimeo';
 
 export default {
-  components: { SpeedkitVimeo },
+  components: { BoosterVimeo },
 
   inheritAttrs: false,