str8r-static

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

Install

Requires NodeJS v18 or v20 LTS

> npm install

Start locally

> npm start

Run with Docker

> npm run docker-up

> npm run docker-down

Build

> 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

Why use Node to start Docker?

The Node process has a few advantages:

• Automatically find an available port to run Browsersync on
• Name the container in Docker Desktop to match the project name
• Make running multiple str8r sites at the same time easy
• Fix a problem with Windows file change event detection

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.

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.
    • site.json - General site settings.
  • 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)
• assets
  • img - Images. These will be automatically optimized and have webp versions created for gif, jpg, and png files.
  • img-resizes - Images placed into the directory will be automatically resized and based on settings contained within the directory and then optimized. See src/assets/img-resizes/readme.md.
  • js - Scripts
  • scss - SASS files