Skip to content

README.md

Latest commit

 

History

History
59 lines (46 loc) · 2.16 KB

README.md

File metadata and controls

59 lines (46 loc) · 2.16 KB

codesthings.com

Personal portfolio and CV site for James Macmillan. Built as a minimal static site generator: JSON data files rendered through EJS templates into plain HTML/CSS/JS.

Live site: codesthings.com

Quick Start

# Docker (recommended)
make dev          # Watch + serve at http://localhost:8080

# Without Docker
npm install
npm start         # Build to public/
npm run server    # Serve at http://localhost:8080

Directory Structure

src/              Build pipeline and source files
  index.js        Main build script
  server.js       Dev server
  watch.js        File watcher
  pages.js        GitHub Pages build
  config.js       Path configuration
  utils.js        File I/O helpers
  templates/      EJS templates (index.ejs, blog.ejs, sections/)
  css/            Stylesheets
  js/             Client-side JS (theme toggle, animations)
  assets/         Icons, images, logos, favicons, fonts
data/             Site content as JSON + blog posts as Markdown
raw/              Source design files (Illustrator, tracked via LFS)
public/           Build output (gitignored)
pages/            GitHub Pages output (gitignored)
docs/             Project documentation

Make Targets

Target Description
make build Build via Docker (includes PDF generation via Gotenberg)
make serve Serve built site at http://localhost:8080 (Docker)
make dev Local development: watch + serve (Docker)
make pages Build GitHub Pages output (Docker)
make clean Remove build output, stop containers

Deployment

Push to main triggers GitHub Actions: build site, generate PDF via Gotenberg, deploy to pages branch, published at codesthings.com via GitHub Pages.

Socials