feat(seo): add schema org

.github/workflows/deploy-to-production.yml

@@ -14,27 +14,31 @@ jobs:
           - tag: prod-fr
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "https://api.werewolves-assistant.com"
             NUXT_PUBLIC_DEFAULT_LOCALE: "fr"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "https://werewolves-assistant.com"
             NUXT_SITE_NAME: "Assistant Loups-Garous"
             NUXT_SITE_ENV: "production"
             NUXT_SITE_DESCRIPTION: "L'outil parfait pour les Maîtres du jeu des Loups-Garous de Thiercelieux™"
           - tag: prod-en
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "https://api.werewolves-assistant.com"
             NUXT_PUBLIC_DEFAULT_LOCALE: "en"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "https://werewolves-assistant.com"
             NUXT_SITE_NAME: "Werewolves Assistant"
             NUXT_SITE_ENV: "production"
             NUXT_SITE_DESCRIPTION: "The perfect tool for game masters of the Werewolves of Miller's Hollow™"
           - tag: local-prod-fr
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "http://localhost:9191"
             NUXT_PUBLIC_DEFAULT_LOCALE: "fr"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "http://localhost:3000"
             NUXT_SITE_NAME: "Assistant Loups-Garous"
             NUXT_SITE_ENV: "production"
             NUXT_SITE_DESCRIPTION: "L'outil parfait pour les Maîtres du jeu des Loups-Garous de Thiercelieux™"
           - tag: local-prod-en
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "http://localhost:9191"
             NUXT_PUBLIC_DEFAULT_LOCALE: "en"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "http://localhost:3000"
             NUXT_SITE_NAME: "Werewolves Assistant"
             NUXT_SITE_ENV: "production"
@@ -65,6 +69,7 @@ jobs:
           build-args: |
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL=${{ matrix.NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL }}
             NUXT_PUBLIC_DEFAULT_LOCALE=${{ matrix.NUXT_PUBLIC_DEFAULT_LOCALE }}
+            NUXT_PUBLIC_CONTACT_EMAIL=${{ matrix.NUXT_PUBLIC_CONTACT_EMAIL }}
             NUXT_SITE_URL=${{ matrix.NUXT_SITE_URL }}
             NUXT_SITE_NAME=${{ matrix.NUXT_SITE_NAME }}
             NUXT_SITE_ENV=${{ matrix.NUXT_SITE_ENV }}

.github/workflows/push-on-develop.yml

@@ -19,27 +19,31 @@ jobs:
           - tag: preprod-fr
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "https://preprod.api.werewolves-assistant.com"
             NUXT_PUBLIC_DEFAULT_LOCALE: "fr"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "https://preprod.werewolves-assistant.com"
             NUXT_SITE_NAME: "Preprod Assistant Loups-Garous"
             NUXT_SITE_ENV: "development"
             NUXT_SITE_DESCRIPTION: "[Preprod] - L'outil parfait pour les Maîtres du jeu des Loups-Garous de Thiercelieux™"
           - tag: preprod-en
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "https://preprod.api.werewolves-assistant.com"
             NUXT_PUBLIC_DEFAULT_LOCALE: "en"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "https://preprod.werewolves-assistant.com"
             NUXT_SITE_NAME: "Preprod Werewolves Assistant"
             NUXT_SITE_ENV: "development"
             NUXT_SITE_DESCRIPTION: "[Preprod] - The perfect tool for game masters of the Werewolves of Miller's Hollow™"
           - tag: local-preprod-fr
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "http://localhost:9292"
             NUXT_PUBLIC_DEFAULT_LOCALE: "fr"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "http://localhost:3001"
             NUXT_SITE_NAME: "Preprod Assistant Loups-Garous"
             NUXT_SITE_ENV: "development"
             NUXT_SITE_DESCRIPTION: "[Preprod] - L'outil parfait pour les Maîtres du jeu des Loups-Garous de Thiercelieux™"
           - tag: local-preprod-en
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: "http://localhost:9292"
             NUXT_PUBLIC_DEFAULT_LOCALE: "en"
+            NUXT_PUBLIC_CONTACT_EMAIL: "antoine.zanardi@epitech.eu"
             NUXT_SITE_URL: "http://localhost:3001"
             NUXT_SITE_NAME: "Preprod Werewolves Assistant"
             NUXT_SITE_ENV: "development"
@@ -64,6 +68,7 @@ jobs:
           build-args: |
             NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL=${{ matrix.NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL }}
             NUXT_PUBLIC_DEFAULT_LOCALE=${{ matrix.NUXT_PUBLIC_DEFAULT_LOCALE }}
+            NUXT_PUBLIC_CONTACT_EMAIL=${{ matrix.NUXT_PUBLIC_CONTACT_EMAIL }}
             NUXT_SITE_URL=${{ matrix.NUXT_SITE_URL }}
             NUXT_SITE_NAME=${{ matrix.NUXT_SITE_NAME }}
             NUXT_SITE_ENV=${{ matrix.NUXT_SITE_ENV }}

Dockerfile

@@ -6,6 +6,7 @@ ENV CI="true"
 
 ARG NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL
 ARG NUXT_PUBLIC_DEFAULT_LOCALE
+ARG NUXT_PUBLIC_CONTACT_EMAIL
 ARG NUXT_SITE_URL
 ARG NUXT_SITE_NAME
 ARG NUXT_SITE_ENV
@@ -41,6 +42,7 @@ ENV CI="true"
 
 ARG NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL
 ARG NUXT_PUBLIC_DEFAULT_LOCALE
+ARG NUXT_PUBLIC_CONTACT_EMAIL
 ARG NUXT_SITE_URL
 ARG NUXT_SITE_NAME
 ARG NUXT_SITE_ENV

README.md

@@ -561,6 +561,7 @@ Environment variables are :
 |:-----------------------------------------------:|:----------------------------------------------------------------------:|:--------:|:-------------:|:----------------------------------------------:|
 | `NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL` |                  URL of the Werewolves Assistant API                   |    ✅     |       ❌       |              Must be a valid URL               |
 |          `NUXT_PUBLIC_DEFAULT_LOCALE`           |                   Locale used when starting the app                    |    ❌     |     `en`      |          Must be either `en` or `fr`           |
+|           `NUXT_PUBLIC_CONTACT_EMAIL`           |                       Contact email for the app                        |    ✅     |       ❌       |         Must be a valid email address          |
 |       `SKIP_SCREENSHOTS_COMPARISON_TESTS`       | In E2E tests, skip all screenshots comparisons, not used in production |    ❌     |    `false`    |        Must be either `true` or `false`        |
 |                 `NUXT_SITE_URL`                 |                  Used for SEO, base URL for the site                   |    ✅     |       ❌       |              Must be a valid URL               |
 |                `NUXT_SITE_NAME`                 |            Used for SEO, name of the site (Used in titles)             |    ✅     |       ❌       |             Must be a valid string             |

app/components/pages/index/IndexFooter.vue

@@ -7,7 +7,7 @@
       <a
         id="contact-button"
         class="p-button p-button-secondary"
-        href="mailto: antoine.zanardi@epitech.eu"
+        :href="contactButtonHref"
       >
         <FontAwesomeIcon
           icon="envelope"
@@ -29,4 +29,8 @@
 import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
 
 import GitHubRepositoryButton from "~/components/shared/external/GitHubRepositoryButton/GitHubRepositoryButton.vue";
+
+const runtimeConfig = useRuntimeConfig();
+
+const contactButtonHref = computed<string>(() => `mailto:${runtimeConfig.public.contactEmail}`);
 </script>

config/vitest/vitest.unit-config.ts

@@ -7,7 +7,20 @@ export default defineVitestConfig({
     pool: "threads",
     root: fileURLToPath(new URL("../../", import.meta.url)),
     environment: "nuxt",
-    environmentOptions: { nuxt: { rootDir: fileURLToPath(new URL("../../", import.meta.url)) } },
+    environmentOptions: {
+      nuxt: {
+        rootDir: fileURLToPath(new URL("../../", import.meta.url)),
+        overrides: {
+          runtimeConfig: {
+            public: {
+              defaultLocale: "en",
+              werewolvesAssistantApi: { baseUrl: "http://127.0.0.1" },
+              contactEmail: "john@doe.com",
+            },
+          },
+        },
+      },
+    },
     setupFiles: ["./tests/unit/unit-setup.ts"],
     watch: false,
     include: ["./tests/unit/**/*.spec.ts"],

env/.env.example

@@ -1,5 +1,6 @@
 NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL="http://127.0.0.1:8080"
 NUXT_PUBLIC_DEFAULT_LOCALE="en"
+NUXT_PUBLIC_CONTACT_EMAIL="john@doe.com"
 NUXT_SITE_URL="http://127.0.0.1:3000"
 NUXT_SITE_NAME="Werewolves Assistant"
 NUXT_SITE_ENV="development"

nuxt.config.ts

@@ -15,6 +15,7 @@ const modules = [
   "@nuxtjs/sitemap",
   "@nuxtjs/robots",
   "nuxt-og-image",
+  "nuxt-schema-org",
   "@vite-pwa/nuxt",
   "@nuxt/devtools",
 ];
@@ -220,21 +221,45 @@ export default defineNuxtConfig({
       ],
     },
   },
+  robots: {
+    disallow: ["/game/"],
+  },
   routeRules: {
     "/": { prerender: true },
     "/about": { swr: true },
     "/game-lobby": { swr: true },
-    "/game": { ssr: false },
-    "/game/**": { ssr: false },
+    "/game": {
+      ssr: false,
+      robots: false,
+    },
+    "/game/**": {
+      ssr: false,
+      robots: false,
+    },
   },
   runtimeConfig: {
     public: {
       defaultLocale: "en",
       werewolvesAssistantApi: { baseUrl: "" },
+      contactEmail: "",
     },
   },
   schemaOrg: {
-    enabled: false,
+    identity: {
+      type: "Organization",
+      name: process.env.NUXT_SITE_NAME ?? "Werewolves Assistant",
+      url: process.env.NUXT_SITE_URL,
+      logo: `${process.env.NUXT_SITE_URL}/_ipx/w_400/img/logo/square/werewolves-logo.webp`,
+      sameAs: [
+        "https://github.com/antoinezanardi/werewolves-assistant-api-next",
+        "https://github.com/antoinezanardi/werewolves-assistant-web-next",
+      ],
+      contactPoint: {
+        type: "ContactPoint",
+        email: process.env.NUXT_PUBLIC_CONTACT_EMAIL,
+        contactType: "Creator",
+      },
+    },
   },
   seo: {
     fallbackTitle: false,

package.json

@@ -147,6 +147,7 @@
     "msw": "^2.4.11",
     "nuxt": "^3.13.1",
     "nuxt-og-image": "^3.0.4",
+    "nuxt-schema-org": "^3.4.0",
     "ofetch": "^1.4.1",
     "pinia": "^2.2.4",
     "pixelmatch": "^6.0.0",