feat(seo): add schema org

antoinezanardi · Oct 14, 2024 · e604558 · e604558
1 parent f49943a
commit e604558
Show file tree

Hide file tree

Showing 12 changed files with 2,407 additions and 2,274 deletions.
diff --git a/.github/workflows/deploy-to-production.yml b/.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 }}

diff --git a/.github/workflows/push-on-develop.yml b/.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 }}

diff --git a/README.md b/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             |

diff --git a/app/components/pages/index/IndexFooter.vue b/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,9 @@
 import { FontAwesomeIcon } from "@fortawesome/vue-fontawesome";
 
 import GitHubRepositoryButton from "~/components/shared/external/GitHubRepositoryButton/GitHubRepositoryButton.vue";
+
+const runtimeConfig = useRuntimeConfig();
+const { contactEmail } = runtimeConfig.public;
+
+const contactButtonHref = `mailto:${contactEmail}`;
 </script>
diff --git a/config/vitest/vitest.unit-config.ts b/config/vitest/vitest.unit-config.ts
@@ -15,6 +15,7 @@ export default defineVitestConfig({
             public: {
               defaultLocale: "en",
               werewolvesAssistantApi: { baseUrl: "http://127.0.0.1" },
+              contactEmail: "john@doe.com",
             },
           },
         },

diff --git a/env/.env.example b/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"

diff --git a/nuxt.config.ts b/nuxt.config.ts
@@ -241,6 +241,7 @@ export default defineNuxtConfig({
     public: {
       defaultLocale: "en",
       werewolvesAssistantApi: { baseUrl: "" },
+      contactEmail: "",
     },
   },
   schemaOrg: {
@@ -255,7 +256,7 @@ export default defineNuxtConfig({
       ],
       contactPoint: {
         type: "ContactPoint",
-        email: "antoine.zanardi@epitech.eu",
+        email: process.env.NUXT_PUBLIC_CONTACT_EMAIL,
         contactType: "Creator",
       },
     },

diff --git a/tests/acceptance/features/home/features/home.feature b/tests/acceptance/features/home/features/home.feature
@@ -10,8 +10,8 @@ Feature: 🏠 Home Page
     And the link with name "What is it?" should be visible
     And the link with name "Contact the creator" should be visible
     And the link with name "Contact the creator" should have the following attributes
-      | name | value                              |
-      | href | mailto: antoine.zanardi@epitech.eu |
+      | name | value                |
+      | href | mailto: john@doe.com |
     And the link with name "This project is open-source!" should be visible
     And the page should match or creates the missing snapshot with name "Home Page"
 

diff --git a/tests/acceptance/features/support/hooks.ts b/tests/acceptance/features/support/hooks.ts
@@ -19,6 +19,7 @@ const { beforeEach, afterEach, afterAll, setup } = createTest({
       env: {
         NUXT_PUBLIC_WEREWOLVES_ASSISTANT_API_BASE_URL: WEREWOLVES_ASSISTANT_SANDBOX_API_BASE_URL,
         NUXT_PUBLIC_DEFAULT_LOCALE: I18N_TEST_LOCALE,
+        NUXT_PUBLIC_CONTACT_EMAIL: "john@doe.com",
         NUXT_SITE_URL: "http://127.0.0.1:4000",
         NUXT_SITE_NAME: "Werewolves Assistant",
         NUXT_SITE_ENV: "test",
@@ -37,6 +38,7 @@ const { beforeEach, afterEach, afterAll, setup } = createTest({
       public: {
         defaultLocale: I18N_TEST_LOCALE,
         werewolvesAssistantApi: { baseUrl: WEREWOLVES_ASSISTANT_SANDBOX_API_BASE_URL },
+        contactEmail: "john@doe.com",
       },
     },
   },