This is a Next.js project bootstrapped with create-next-app.

This project uses TinaCMS and a custom middleware that allows for a multi-domain architecture.

The purpose of this repository is to host the product pages for SSW's custom software.

Running this project locally?

1. Get access to the environment variables from Keeper

2. Paste the varables into your .env file

3. Install Dependencies

yarn install

Note for Windows: Remove TINA_PUBLIC_IS_LOCAL=true from package.json, only keeping the tinacms command.

3. Run the development server:

yarn dev

4. Open http://localhost:3000 with your browser to see the result.

5. You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Note: We temporarily disabled the Visual Editing feature due to this issue. To enable it, you can uncomment the ui section in tina/collectionSchema/pages.tsx.

To add an extra tenant/ domain you must

1. Add project configuration to the NEXT_PUBLIC_PRODUCT_LIST environment variable in Vercel. For example, {"product": "YakShaver", "domain": "www.yakshaver.ai"}

2. Add custom domain to the Vercel. Then follow the instructions to add the configuration to your domain provider.

How does the MiddleWare work?

Context: Our file structure within our app router looks like

|- app
|   |- page.tsx
|   |- [product]
|          |- [filename]
|                  |- page.tsx

When the user serves the site a respective domain (i.e think www.YakShaver.ai), it will try to find a respective product mapping from the NEXT_PUBLIC_PRODUCT_LIST. If it successfully finds a product, it will fill the [product] dynamic mapping with the product value found from the NEXT_PUBLIC_PRODUCT_LIST. Then when it comes to serving data, our page.tsx will use relativePath: ${product}/home.json using the specific product it found related to the domain.

This also means we have to set up the file structure for where we store our content. This is how we've organised our content structure;

|- content
      |- blogs
      |- footer
      ... other TinaCMS collections
      |- pages
           |- Product1
                 |- home.json
           |- Product2
                 |- home.json

Note in this instance Product1 and Product2 are just the product names such like YakShaver or TimePro

Updating the docs pages

Because we are using Algolia for our search functionality you'll need to rebuild the search indices when changes are made to the docs. In order to do this complete the following steps:

1. Get your changes to the docs pages merged into main
2. Pull the main branch on your local machine
3. Ensure that you have the Algolia environment variables in your env file you retrieved in the previous section (i.e. Running this project locally)
4. After ensuring that you've installed the node version in the .nvmrc file in the project root, Run the following command yarn run rebuild-search-indices

Wanting to use the Middleware for your own site?

We've documented how we use this middleware for our own sites and clients - Do you know how to use single codebase for multiple domains with TinaCMS and Next.js?

Updating the sitemap

If you are adding a new page using one of the existing Tina collections for the site, you do not need to update the sitemap as it will automatically include the new page.

If you are however adding a new collection for a page template you'll need to update the sitemap returned by app/sitemap.xml/route.tsx to include the new collection.