str8r-veeva-clm

Based off str8r-static v3.x

Clone this to start a generic str8r (siterator) project.

Install

Requires NodeJS v18/20/22+ LTS

> npm install

Helper apps

> npm run apps

• Page creator: create a new page directory with SASS and JS files
• links.json maintenance: helps add new pages to the links.json file and fixes any ID issues
• Veeva configuration: generate the Veeva config file when dev is complete.

Start locally (recommended)

> npm start

Run with Docker

> npm run docker-up

> npm run docker-down

Build Veeva packages

Generates thumbnails, creates ZIP files and CSV for multichannel loader

> npm run veeva

Generates as a training versions

> npm run veeva-training

Create a CSV for a fields-only update via the multichannel loader

> npm run veeva-fields

Build (for web deployments)

> npm run build

Build and serve

> npm run build-serve

Pass build arguments

> npm run build -- --env=prd --host=aws

Build with Docker

> npm run docker-build

Gulp

View available gulp tasks

> npx gulp --tasks

Project Directories

.str8r

Temporary files used by str8r. When running locally, Browsersync serves files from .str8r/dev.

config

Override default build and runtime settings, including changing the directory locations listed below. See individual config/*.md files for more details.

dist

Built project output.

dist-veeva

Veeva dist packages

src

Project source.

• _handlebars
  • data - Data files available within the Handlebars context
    • links.json - Project links. See src/_handlebars/data/links.md.
    • nav.json - Nav menu settings for the {{nav}} helper. See src/_handlebars/data/nav.md.
  • helpers - Helpers. Str8r provides a number of helpers. See src/_handlebars/helpers/readme.md.
  • layouts - Layout partials
  • partials - Partials
  • templates - Template partials (nav, robots, sitemap)