Command Line Tools & Build Automation

Everything you need to build, test, lint, and serve the DocTunes static documentation suite locally and in CI/CD pipelines.

npm run devnpm script

Starts the local development server on port 3000 with hot reloading.

bash

npm run dev

npm run buildnpm script

Compiles all 20 pages into static HTML and builds out/ sitemap.xml.

bash

npm run build

npm run lintnpm script

Executes ESLint across all TypeScript and React components.

bash

npm run lint

npx serve outnpm script

Serves the static production out directory locally for verification.

bash

npx serve out -p 8080

GitHub Actions Static Deploy Workflow

Add this workflow to .github/workflows/deploy.yml for automated static deployment to GitHub Pages or S3 on every push:

yaml

name: Deploy Static Documentation
on:
  push:
    branches: [main]

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 20
      - run: npm ci
      - run: npm run build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./out

← Back to Architecture Next: Configuration