QuickSite Template

A minimalist, site-only GitHub template designed for rapid deployment of static or client-side rendered websites. It features a lightweight, zero-configuration build pipeline powered entirely by Node.js utilities for asset management and a seamless development experience with GitHub Codespaces.

Features

• Zero-Config Build: Uses pure Node.js (fs, terser, clean-css) for asset processing—no Webpack, Parcel, or Gulp needed.
• Asset Bundling: Concatenates and minifies all source JavaScript and CSS into single files (script.js, style.css).
• Automatic Setup: Configured with npm ci and Codespace settings to be ready to run instantly.
• Integrated Server: Built-in development server runs on port 4920 for immediate testing of the build output.

---

Project Structure

Development work happens exclusively inside the src/ directory. The npm run build command handles moving and processing files into the output directory, dist/.

/
├── .devcontainer/       \# GitHub Codespaces setup (automatic environment)
├── src/
│   ├── index.html       \# The main entry point (kept clean)
│   ├── css/             \# All CSS source files (concatenated & minified)
│   ├── js/              \# All JavaScript source files (concatenated & minified)
│   └── assets/          \# Images, fonts, favicons (copied recursively to /dist/assets)
├── dist/                \# ⬅️ BUILD OUTPUT (Ignored by Git)
├── package.json         \# Dependencies and scripts
├── build.js             \# Core build logic (bundling, minification, path replacement)
├── serve.js             \# Development server logic
└── clean.js             \# Cleanup script

---

Getting Started

1. Setup

If you are using GitHub Codespaces, dependencies are installed and the project is built automatically. If you are developing locally, run:

# Install dependencies (terser, clean-css, glob)
npm install

2. Available Scripts

Use these commands from your terminal to manage your project:

Command	Action	Description
npm run clean	node clean.js	Deletes the entire /dist directory.
npm run build	npm run clean && node build.js	Runs a clean, then builds and minifies all assets into the /dist folder.
npm start	npm run build && node serve.js	Runs the build, then starts the development server on http://localhost:4920.
npm run dev	Alias for npm start.	The recommended command for development.

3. Development

1. Make all code changes in the src/ folder.
2. Run npm start (or npm run dev) in your terminal.
3. View your site in the browser at http://localhost:4920. The server will serve the bundled, minified code directly from the /dist folder.

---

🚀 Deployment

The entire contents of the /dist folder are your production-ready site. This folder can be pointed to by services like GitHub Pages, Vercel, Netlify, or uploaded to any standard web hosting environment.