Add og metatags to public facing pages

.env.defaults

@@ -18,6 +18,8 @@ PRISMA_HIDE_UPDATE_MESSAGE=true
 FIRST_NAME=firstname
 LAST_NAME=lastname
 
+COUNTRY=US
+
 SMTP_HOST=smtp.example.com
 SMTP_PORT=465
 SMTP_SECURE=true

.env.example

@@ -6,6 +6,8 @@
 FIRST_NAME=firstname
 LAST_NAME=lastname
 
+COUNTRY=US
+
 SMTP_HOST=smtp.example.com
 SMTP_PORT=465
 SMTP_SECURE=true

README.md

@@ -21,9 +21,10 @@ services:
       - API_PROXY_TARGET=http://localhost:8911
       - MAX_HTTP_CONNECTIONS_PER_MINUTE=60
       - SESSION_SECRET=super_secret_session_key_change_me_in_production_please
-      - DATABASE_URL=postgresql://redwood:changeme@db:5432/portfolio
+      - DATABASE_URL=postgresql://redwood:changeme@db/portfolio
       - FIRST_NAME=first name                               # Your first name
       - LAST_NAME=lastname                                  # Your last name
+      - COUNTRY=US                                          # ISO-3166-1 alpha-2 country code, https://en.wikipedia.org/wiki/ISO_3166-1#Codes
       - SMTP_HOST=smtp.example.com
       - SMTP_PORT=465
       - SMTP_SECURE=true
@@ -58,8 +59,6 @@ services:
       - POSTGRES_USER=redwood
       - POSTGRES_PASSWORD=changeme
       - POSTGRES_DB=portfolio
-    ports:
-      - 5432:5432
     volumes:
       - postgres:/var/lib/postgresql/data
 
@@ -75,9 +74,9 @@ sudo docker exec -u root portfolio chown -R node:node /home/node/app/api/files_p
 ## Logging In
 - Once the container is up and running, head to `/login` (`https://portfolio.example.com/login`), default credentials are below
 - If you would like to change the password, head to `/forgot-password` (`https://portfolio.example.com/forgot-password`), the username is `admin`
-  - If you correctly set up the Gmail app password, you should receive an email from yourself
-  - It contains the link needed to change your password
+  - If you correctly configured [SMTP](#smtp), you should receive an Email from [`EMAIL_FROM`](#docker-compose) to [`EMAIL_TO`](#docker-compose)
+  - The Email contains the link needed to change your password
 ### Default Credentials
 **Username:** `admin`
 
-**Password:** [`SMTP_PASSWORD`](#smtp)
+**Password:** [`SMTP_PASSWORD`](#docker-compose)

api/package.json

@@ -11,6 +11,7 @@
     "@redwoodjs/graphql-server": "8.4.0",
     "@tus/file-store": "^1.4.0",
     "@tus/server": "^1.7.0",
+    "country-flag-icons": "^1.5.13",
     "graphql-scalars": "^1.23.0",
     "nodemailer": "^6.9.14"
   },

api/src/server.ts

@@ -10,6 +10,13 @@ import { createServer } from '@redwoodjs/api-server'
 import { logger } from 'src/lib/logger'
 import { handleTusUpload } from 'src/lib/tus'
 ;(async () => {
+  const { hasFlag } = await import('country-flag-icons')
+
+  if (!hasFlag(process.env.COUNTRY))
+    throw new Error(
+      'Invalid COUNTRY environment variable, please select a valid ISO-3166-1 alpha-2 country code\n See https://en.wikipedia.org/wiki/ISO_3166-1#Codes'
+    )
+
   const server = await createServer({
     logger,
     configureApiServer: async (server) => {

docker-compose.yml

@@ -9,9 +9,10 @@ services:
       - API_PROXY_TARGET=http://localhost:8911
       - MAX_HTTP_CONNECTIONS_PER_MINUTE=60
       - SESSION_SECRET=super_secret_session_key_change_me_in_production_please
-      - DATABASE_URL=postgresql://redwood:changeme@db:5432/portfolio
+      - DATABASE_URL=postgresql://redwood:changeme@db/portfolio
       - FIRST_NAME=first name                               # Your first name
       - LAST_NAME=lastname                                  # Your last name
+      - COUNTRY=US                                          # ISO-3166-1 alpha-2 country code, https://en.wikipedia.org/wiki/ISO_3166-1#Codes
       - SMTP_HOST=smtp.example.com
       - SMTP_PORT=465
       - SMTP_SECURE=true
@@ -46,8 +47,6 @@ services:
       - POSTGRES_USER=redwood
       - POSTGRES_PASSWORD=changeme
       - POSTGRES_DB=portfolio
-    ports:
-      - 5432:5432
     volumes:
       - postgres:/var/lib/postgresql/data
 

redwood.toml

@@ -9,7 +9,7 @@
   title = "${FIRST_NAME} ${LAST_NAME}"
   port = 8910
   apiUrl = "/api"
-  includeEnvironmentVariables = ["FIRST_NAME", "LAST_NAME", "API_ADDRESS_PROD", "API_ADDRESS_DEV"]
+  includeEnvironmentVariables = ["FIRST_NAME", "LAST_NAME", "COUNTRY", "API_ADDRESS_PROD", "API_ADDRESS_DEV"]
 [generate]
   tests = false
   stories = false

web/package.json

@@ -35,6 +35,7 @@
     "@uppy/react": "^4.0.1",
     "@uppy/tus": "^4.0.0",
     "@uppy/webcam": "^4.0.1",
+    "country-flag-icons": "^1.5.13",
     "date-fns": "^4.1.0",
     "humanize-string": "2.1.0",
     "react": "18.3.1",

web/src/components/ContactCard/ContactCardCell/ContactCardCell.tsx

@@ -3,10 +3,12 @@ import type {
   ContactCardPortraitVariables,
 } from 'types/graphql'
 
-import type {
-  TypedDocumentNode,
-  CellFailureProps,
-  CellSuccessProps,
+import { routes } from '@redwoodjs/router'
+import {
+  type TypedDocumentNode,
+  type CellFailureProps,
+  type CellSuccessProps,
+  Metadata,
 } from '@redwoodjs/web'
 
 import CellEmpty from 'src/components/Cell/CellEmpty/CellEmpty'
@@ -43,5 +45,20 @@ export const Success = ({
   portrait,
   socials,
 }: CellSuccessProps<ContactCardPortrait, ContactCardPortraitVariables>) => (
+  <>
+    <Metadata
+      title="Contact"
+      og={{
+        title: 'Contact',
+        type: 'website',
+        image: {
+          url: portrait.fileId,
+          type: 'image/webp',
+          alt: `${process.env.FIRST_NAME} ${process.env.LAST_NAME}`,
+        },
+        url: routes.contact(),
+      }}
+    />
     <ContactCard portraitUrl={portrait.fileId} socials={socials} />
+  </>
 )

web/src/components/Project/Project/Project.tsx

@@ -69,10 +69,13 @@ const Project = ({ project }: Props) => {
             </div>
           </>
         )}
+        {project.images.length > 0 && (
           <h2 className="sm:hidden font-bold text-3xl text-center">Images</h2>
+        )}
       </div>
-      <div className="flex flex-wrap gap-4 items-center pt-8 justify-center">
-        {project.images.map((image, i) => (
+      <div className="flex flex-wrap gap-4 pt-8 justify-center h-fit">
+        {project.images.length > 0 &&
+          project.images.map((image, i) => (
             <a
               href={image}
               target="_blank"

web/src/components/Project/ProjectCell/ProjectCell.tsx

@@ -1,9 +1,11 @@
 import type { FindProjectById, FindProjectByIdVariables } from 'types/graphql'
 
-import type {
-  CellSuccessProps,
-  CellFailureProps,
-  TypedDocumentNode,
+import { routes } from '@redwoodjs/router'
+import {
+  type CellSuccessProps,
+  type CellFailureProps,
+  type TypedDocumentNode,
+  Metadata,
 } from '@redwoodjs/web'
 
 import CellEmpty from 'src/components/Cell/CellEmpty/CellEmpty'
@@ -40,5 +42,23 @@ export const Failure = ({
 export const Success = ({
   project,
 }: CellSuccessProps<FindProjectById, FindProjectByIdVariables>) => (
+  <>
+    <Metadata
+      title={project.title}
+      og={{
+        title: project.title,
+        type: 'website',
+        image:
+          project.images.length > 0
+            ? {
+                url: project.images[0],
+                type: 'image/webp',
+                alt: 'Image 1',
+              }
+            : undefined,
+        url: routes.project({ id: project.id }),
+      }}
+    />
     <Project project={project} />
+  </>
 )

web/src/components/Project/ProjectsShowcaseCell/ProjectsShowcaseCell.tsx

@@ -1,9 +1,11 @@
 import type { FindProjects, FindProjectsVariables } from 'types/graphql'
 
-import type {
-  CellSuccessProps,
-  CellFailureProps,
-  TypedDocumentNode,
+import { routes } from '@redwoodjs/router'
+import {
+  type CellSuccessProps,
+  type CellFailureProps,
+  type TypedDocumentNode,
+  Metadata,
 } from '@redwoodjs/web'
 
 import CellEmpty from 'src/components/Cell/CellEmpty/CellEmpty'
@@ -40,5 +42,16 @@ export const Failure = ({ error }: CellFailureProps<FindProjectsVariables>) => (
 export const Success = ({
   projects,
 }: CellSuccessProps<FindProjects, FindProjectsVariables>) => (
+  <>
+    <Metadata
+      title="Projects"
+      og={{
+        title: 'Projects',
+        type: 'website',
+        description: `${projects.length} projects`,
+        url: routes.projects(),
+      }}
+    />
     <ProjectsShowcase projects={projects} />
+  </>
 )

web/src/components/Resume/ResumeCell/ResumeCell.tsx

@@ -1,9 +1,11 @@
 import type { FindResume, FindResumeVariables } from 'types/graphql'
 
-import type {
-  CellSuccessProps,
-  CellFailureProps,
-  TypedDocumentNode,
+import { routes } from '@redwoodjs/router'
+import {
+  type CellSuccessProps,
+  type CellFailureProps,
+  type TypedDocumentNode,
+  Metadata,
 } from '@redwoodjs/web'
 
 import CellEmpty from 'src/components/Cell/CellEmpty/CellEmpty'
@@ -29,5 +31,15 @@ export const Failure = ({ error }: CellFailureProps<FindResumeVariables>) => (
 export const Success = ({
   resume,
 }: CellSuccessProps<FindResume, FindResumeVariables>) => (
+  <>
+    <Metadata
+      title="Contact"
+      og={{
+        title: 'Resume',
+        type: 'website',
+        url: routes.resume(),
+      }}
+    />
     <Resume resume={resume} />
+  </>
 )

web/src/entry.client.tsx

@@ -1,3 +1,4 @@
+import { hasFlag } from 'country-flag-icons'
 import { hydrateRoot, createRoot } from 'react-dom/client'
 
 import App from 'src/App'
@@ -15,6 +16,11 @@ if (!redwoodAppElement)
       "exists in your 'web/src/index.html' file."
   )
 
+if (!hasFlag(process.env.COUNTRY))
+  throw new Error(
+    'Invalid COUNTRY environment variable, please select a valid ISO-3166-1 alpha-2 country code\n See https://en.wikipedia.org/wiki/ISO_3166-1#Codes'
+  )
+
 if (redwoodAppElement.children?.length > 0)
   hydrateRoot(redwoodAppElement, <App />)
 else {

web/src/pages/ContactPage/ContactPage.tsx

@@ -1,7 +1,5 @@
 import { useEffect, useRef, useState } from 'react'
 
-import { Metadata } from '@redwoodjs/web'
-
 import ContactCardCell from 'src/components/ContactCard/ContactCardCell'
 
 const ContactPage = () => {
@@ -29,13 +27,9 @@ const ContactPage = () => {
   }, [width, height])
 
   return (
-    <>
-      <Metadata title="Contact" />
-
     <div className="flex min-h-[calc(100vh-6rem)] items-center justify-center">
       <ContactCardCell />
     </div>
-    </>
   )
 }
 

web/src/pages/HomePage/HomePage.tsx

@@ -1,5 +1,6 @@
 import { mdiCompass, mdiContacts } from '@mdi/js'
 import Icon from '@mdi/react'
+import getUnicodeFlagIcon from 'country-flag-icons/unicode'
 
 import { Link, routes } from '@redwoodjs/router'
 import { Metadata } from '@redwoodjs/web'
@@ -9,7 +10,15 @@ import { getLogoComponent } from 'src/lib/handle'
 
 const HomePage = () => (
   <>
-    <Metadata title="Home" />
+    <Metadata
+      title="Home"
+      og={{
+        title: `${process.env.FIRST_NAME} ${process.env.LAST_NAME}`,
+        description: 'Check out my portfolio!',
+        type: 'website',
+        url: routes.home(),
+      }}
+    />
 
     <div className="hero min-h-[calc(100vh-6rem)]">
       <div className="hero-content flex flex-col gap-8">
@@ -44,6 +53,11 @@ const HomePage = () => (
         {getLogoComponent('gitea')}
       </a>
     </div>
+    <div className="fixed bottom-2 right-2 z-10">
+      <p className="btn btn-square text-xl">
+        {getUnicodeFlagIcon(process.env.COUNTRY)}
+      </p>
+    </div>
   </>
 )
 

web/src/pages/Project/ProjectPage/ProjectPage.tsx

@@ -1,5 +1,3 @@
-import { Metadata } from '@redwoodjs/web'
-
 import ProjectCell from 'src/components/Project/ProjectCell'
 
 interface ProjectPageProps {
@@ -7,13 +5,7 @@ interface ProjectPageProps {
 }
 
 const ProjectPage = ({ id }: ProjectPageProps) => {
-  return (
-    <>
-      <Metadata title="Project" />
-
-      <ProjectCell id={id} />
-    </>
-  )
+  return <ProjectCell id={id} />
 }
 
 export default ProjectPage

web/src/pages/Project/ProjectsPage/ProjectsPage.tsx

@@ -1,14 +1,10 @@
 import mobile from 'is-mobile'
 
-import { Metadata } from '@redwoodjs/web'
-
 import ProjectsShowcaseCell from 'src/components/Project/ProjectsShowcaseCell'
 
 const ProjectsPage = () => {
   return (
     <>
-      <Metadata title="Projects" />
-
       <div className="hero min-h-64">
         <div className="hero-content">
           <div className="max-w-md text-center">

web/src/pages/Resume/ResumePage/ResumePage.tsx

@@ -1,15 +1,7 @@
-import { Metadata } from '@redwoodjs/web'
-
 import ResumeCell from 'src/components/Resume/ResumeCell'
 
 const ResumePage = () => {
-  return (
-    <>
-      <Metadata title="Resume" />
-
-      <ResumeCell />
-    </>
-  )
+  return <ResumeCell />
 }
 
 export default ResumePage

yarn.lock

@@ -7336,6 +7336,7 @@ __metadata:
     "@tus/file-store": "npm:^1.4.0"
     "@tus/server": "npm:^1.7.0"
     "@types/nodemailer": "npm:^6.4.15"
+    country-flag-icons: "npm:^1.5.13"
     graphql-scalars: "npm:^1.23.0"
     nodemailer: "npm:^6.9.14"
   languageName: unknown
@@ -9061,6 +9062,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"country-flag-icons@npm:^1.5.13":
+  version: 1.5.13
+  resolution: "country-flag-icons@npm:1.5.13"
+  checksum: 10c0/beee2fe225469507d6c8df90376e031f08a5f103f65cd68e1db0679e82d4ffb2fbb27a3bb19defd112745b5c19d1972df615df21813c8c2074062dd5eb08eabb
+  languageName: node
+  linkType: hard
+
 "crc-32@npm:^1.2.0":
   version: 1.2.2
   resolution: "crc-32@npm:1.2.2"
@@ -19234,6 +19242,7 @@ __metadata:
     "@uppy/tus": "npm:^4.0.0"
     "@uppy/webcam": "npm:^4.0.1"
     autoprefixer: "npm:^10.4.20"
+    country-flag-icons: "npm:^1.5.13"
     daisyui: "npm:^4.12.10"
     date-fns: "npm:^4.1.0"
     humanize-string: "npm:2.1.0"