CMS content pages in Go

What it does

Configuration

One setting, with a default, and nothing to set in the panel. Pages are not configuration: they are rows an operator writes on the Pages screen or through the API.

The module reads its Config struct, not the environment. The variable names are the ones the package’s own example or the reference binary uses; in your own main() you choose where each value comes from. Where a setting has a panel label, the admin’s settings drawer can hold it too, and a value typed there wins over Config.

Setting it up

1. Install the modulePass cms.New to gocommerce.New, as below, or start the reference binary with -cms. It adds the cms_pages table and the Pages screen to the admin’s main nav.
2. Write a pageOn the Pages screen, or POST /api/admin/x/cms/pages with a title and a slug. It is a draft unless the status says published, and in the store’s main language unless the request names one.
3. Publish itSet the status to published. The first publish stamps published_at, and publishing again does not move that date.
4. Read it from the storefrontGET /x/cms/pages/{slug} answers with the page in the shopper’s language, and GET /x/cms/pages lists the published pages in that language, newest first.

import (
	"github.com/itswadesh/gocommerce/core"
	"github.com/itswadesh/gocommerce/ext/cms"
)

app, err := gocommerce.New(cfg, cms.New(cms.Config{}))

How it works

• One page per slug and language

  A unique key on slug and language lets “about” exist once in each of the store’s languages without colliding. Creating a page at a slug already taken in that language, or renaming one onto it, answers 409 with the slug.

• A fallback, not a 404

  A shopper whose browser asks for a translation nobody has written gets the page in the store’s other languages, main first. Only a slug with no published page in any of the store’s languages is a 404.

• Draft or published

  The status is one of the two, checked on create, on update and on the admin list’s filter. Drafts show on the admin routes and never on the public ones.

• SEO as name and value pairs

  Each page carries a free set of string pairs, stored as JSON and handed back as they were. The module does not read or check them; the storefront decides what each name means.

• Rights of its own

  Reading pages in the admin needs pages.read, held by managers and staff by default. Writing, publishing and deleting need pages.write, held by managers.

• Sample pages

  The sample shop adds three published pages, About us, Shipping and delivery, and Returns, in the store’s first language. A slug the store already uses is skipped, and erasing the sample shop removes only the pages it added.

What it does not do

Read these before an order depends on it. No store is known to run GoCommerce in production yet, so these come from the code, not from anyone’s experience.

• Language is fixed at creationAn update cannot change a page’s language. To write a page in another language, create a new one with the same slug.
• The body is kept as sentThe admin edits the body in a rich-text editor. The module stores and serves it as it arrived; it does not render, clean or check it.
• No historyAn update overwrites the page. There are no revisions to compare or restore, and a deleted page is gone.
• No scheduled publishingA page is draft or published from the moment its status is set. There is no publish date in the future.
• Flat pagesA page has no parent and no position. The public list is newest first; linking pages into the storefront’s header or footer is the menus’ job.
• No switch in the Plugins screenThe module registers no plugin. Once installed, the public routes answer for every published page.

Related modules

Each is a directory under ext/, imported the same way. Where this one fits in the store: How modules extend GoCommerce.

• Contact form API in Go A GoCommerce contact form and product enquiries in one inbox: announced by email, answered from the admin, rate-limited, with a honeypot against bots.
• Ecommerce FAQ API in Go Give a GoCommerce store a page of questions and answers: grouped into sections, ordered by hand, draft or published, served whole at /x/faq.
• Customer accounts and login in Go Add shopper accounts to a GoCommerce store: sign-up, sign-in, saved addresses, password reset and order history by claim. Guest checkout keeps working.
• Order and GST tax invoices in Go A numbered invoice for every paid GoCommerce order and, for Indian stores, a GST tax invoice with HSN codes and the tax split, exported to TallyPrime.