antlossway / hello-vpn

Why this document

Hello-VPN is a project that provide B2B site-to-site IPsec VPN service. This README take notes of what I learned when building this website.

Image Attribute

Image by kjpargeter on Freepik

UI

how to change color of svg in react

create a component that receive color as props

// components/DottedLeft.tsx

const DottedLeft = ({fill}:{fill:string}) => {
    return (
        <svg>
          <circle fill={fill} />
        </svg>
    )
}

// page.tsx
<DottedLeft fill="#2dddba">

tailwindcss

use marker CSS pseudo element

when making a list, use marker to modify list content and style. The content can be text,image, html symbol, ...etc. Example:

// \2713 is an html cross symbol
        <ul className="space-y-2 flex-1 marker:content-['\2713'] marker:text-primary-500 [&>*]:pl-2">
          {features.map((feature) => (
            <li key={feature}>
              {feature}
            </li>
          ))}

If not using marker, need to add a image beside the text of list item, which is the current design on this website.

generate sitemap

use next-sitemap

npm install next-sitemap

create /app/next-sitemap.config.js

/** @type {import('next-sitemap').IConfig} */
module.exports = {
  siteUrl: process.env.SITE_URL || "http://localhost:3000",
  generateRobotsTxt: true, // (optional)
  generateIndexSitemap: false,
  // ...other options
}

npm run build

Next.js dynamic sitemap

use sitemap.ts at root level

metadata

To set meta image, which will appear in search engine result.

1. put opengraph-image.png under /app, not /public
2. create opengraph-image.alt.txt, write something about your site
3. add in /app/layout.tsx or /app/(root)/(home)/layout.tsx, the latter will override first.

export const metadata: Metadata = {
  ...
  metadataBase: new URL(process.env.SITE_URL!),
  openGraph: {
    images: "/opengraph-image.png",
  },

Without metadataBase, metadataBase is automatically populated with a default value, which would fall back to http://localhost:3000. That's why it did not work before.

See https://nextjs.org/docs/app/api-reference/functions/generate-metadata#metadatabase

Headless wordpress

styling trick

FAQ page on wordpress used "Details" widget, which is implemented by HTML disclosure widget (details + summary HTML element), There are two styling issues:

• summary cursor pointer
• nested block elements in summary https://css-tricks.com/two-issues-styling-the-details-element-and-how-to-solve-them/

CSS reset fix

// global.css

details summary {
  cursor: pointer;
}

details summary > * {
  display: inline;
}

Example: details

<!-- wp:details -->
<details class="wp-block-details">
	<summary><?php esc_html_e( 'Question 1?', 'themeslug' ); ?></summary>
	<!-- wp:paragraph {"placeholder":"<?php esc_attr_e( 'Add an answer to the question.', 'themeslug' ); ?>"} -->
	<p></p>
	<!-- /wp:paragraph -->
</details>
<!-- /wp:details -->

To style summary, we can add in global.css

/* Base `summary` element styling. */
.wp-block-details summary {
  transition: all 0.5s ease-in-out;
  box-sizing: border-box;
  padding: 1rem;
  font-weight: 700;
  font-size: 1.2rem;
}

How to add authentication to Wordpress REST API

install plugin WordPress REST API Authentication by miniOrange,

select Basic Authentication, generate auth token

export const myAxios = axios.create({
  baseURL: process.env.WP_API_URL,
  headers: {
    Authorization: `Basic ${process.env.WP_BASIC_AUTH}`,
  },
})

Disable search engine index for wordpress site

Since we only use wordpress as headless CMS, wp.ameex-mobile.com should not appear in the search result, otherwise there could be problem of duplicate content.

Login to the server that hosts wordpress, go to root directory of the site, for my case /opt/bitnami/wordpress, create a robots.txt, put in content

# *
User-agent: *
Disallow: /

Next.js

How to statically generate blog posts to speed up /blog speed

// @app/blog/[slug]/page.tsx

export async function generateStaticParams() {
  const { posts } = await getAllPosts()
  return posts.map((post: any) => ({
    slug: post.slug,
  }))
}

why the blog index page always appear as dynamically rendered?

When using npm run build, I noticed the /blog is dynamically rendered, output like below: ├ λ /api/revalidate 0 B 0 B ├ λ /blog 3.42 kB 94.1 kB ├ ● /blog/[slug] 175 B 90.8 kB ├ ├ /blog/cisco-site-to-site-vpn-with-ikev2 ├ ├ /blog/cisco-gre-tunnel-nat-ipsec ├ ├ /blog/how-to-build-gre-over-ipsec-on-aws-cisco-csr1000v ├ └ [+6 more paths]

Then I realize it's due to a tag filter

 const BlogPage = async ({ searchParams }: Props) => {
   const { tag } = searchParams

When the request URL like /blog?tag=vpn , the displayed dataset will filter based on the tag, this makes the page dynamic. When I remove the tag functionality from the code, npm run build is displaying /blog as SSG.

├ λ /api/revalidate 0 B 0 B ├ ○ /blog 178 B 90.8 kB ├ ● /blog/[slug] 179 B 90.8 kB ├ ├ /blog/cisco-site-to-site-vpn-with-ikev2 ├ ├ /blog/cisco-gre-tunnel-nat-ipsec ├ ├ /blog/how-to-build-gre-over-ipsec-on-aws-cisco-csr1000v ├ └ [+6 more paths]

use fetch instead of axios

In order to take advantage of Next.js's built-in caching feature, I replaced axios call to use fetch instead.

export const myFetch = async (url: string) => {
  const res = await fetch(`${process.env.WP_API_URL}${url}`, {
    headers: {
      Authorization: `Basic ${process.env.WP_BASIC_AUTH}`,
    },
    next: { revalidate: parseInt(process.env.REVALIDATE_INTERVAL || "60") },
  })
  const data = await res.json()
  return data
}

Reference

https://developer.wordpress.org/news/2023/12/01/styles-patterns-and-more-with-the-details-block/