Haikus for Codespaces

This is a quick node project template for demoing Codespaces. It is based on the Azure node sample.

Point your browser to Quickstart for GitHub Codespaces for a tour of using Codespaces with this repo.

Local development

npm install
npm run dev

Open http://localhost:3000.

Available scripts

• npm start: Start the production server.
• npm run dev: Start with nodemon.
• npm test: Run API tests.
• npm run lint: Run ESLint checks.
• npm run format: Run Prettier formatting checks.

Health check

The app exposes GET /healthz and returns:

{ "status": "ok" }

Security notes

• Haiku text in templates is rendered using escaped output (<%= ... %>) to reduce XSS risk.
• If data sources change from static JSON to user-provided input, perform server-side sanitization/validation before rendering.

AI Assistant Documentation

This repository includes comprehensive documentation for AI coding assistants:

• AI Assistant Guide - Complete guide for AI assistants (Claude Code, GitHub Copilot Workspace, etc.) to execute tasks accurately and completely. Includes code patterns, security requirements, testing guidelines, and task execution checklists.
• GitHub Copilot Instructions - Repository-specific context for GitHub Copilot code suggestions.

These guides ensure AI assistants follow the project's conventions and best practices when assisting with development tasks.