This document provides a comprehensive overview of the game template repository, a security-first React 19, TypeScript, and Three.js game development template with enterprise-grade CI/CD pipelines, ISMS compliance, and AI-assisted development capabilities. It explains the repository's architecture, key systems, and how they integrate to provide a production-ready foundation for building web-based 3D games.
For detailed information on specific subsystems, see:
Project Name: game-app
Current Version: 1.2.32
Repository URL: https://github.com/Hack23/game
Primary Language: TypeScript (strict mode)
License: Apache-2.0
Sources: package.json2-4 README.md1-3
The repository implements a three-layer architecture consisting of the application runtime, development infrastructure, and security compliance framework.
Sources: README.md43-55 package.json18-26 Diagram 1 from high-level system architecture
The repository leverages modern web technologies with strict version control and security-vetted dependencies.
| Package | Version | Purpose |
|---|---|---|
react | ^19.2.4 | UI framework with hooks and strict mode |
react-dom | ^19.2.4 | React DOM rendering |
three | ^0.183.2 | 3D WebGL rendering engine |
@react-three/fiber | ^9.5.0 | React renderer for Three.js |
@react-three/drei | ^10.7.7 | Three.js helpers and abstractions |
howler | ^2.2.4 | Audio playback library |
react-error-boundary | ^6.1.1 | Error boundary component |
| Package | Version | Purpose |
|---|---|---|
vite | ^7.3.1 | Build tool and dev server |
typescript | ^5.9.3 | Static type checking |
vitest | ^4.0.6 | Unit testing framework |
cypress | ^15.11.0 | E2E testing framework |
eslint | ^9.39.2 | Code linting |
@vitest/coverage-v8 | ^4.0.18 | Code coverage reporting |
Sources: package.json18-26 package.json27-56
The application follows a component-based architecture with centralized state management and declarative 3D rendering.
Sources: docs/index.html1-39 Diagram 3 from high-level system architecture, package.json18-26
The repository implements defense-in-depth through multiple security layers aligned with Hack23 AB's ISMS framework.
Sources: docs/index.html8-29 README.md11-24 SECURITY.md24-70 Diagram 4 from high-level system architecture
The repository supports three development modes with comprehensive tooling and AI assistance.
Sources: README.md199-238 README.md57-86 docs/COPILOT_QUICK_START.md1-100 Diagram 5 from high-level system architecture
The repository enforces quality through a multi-layered testing strategy with mandatory coverage thresholds.
Sources: package.json12-16 README.md523-556 Diagram 6 from high-level system architecture
The repository implements a comprehensive CI/CD pipeline with parallel security scanning and automated deployment.
Sources: README.md554-616 Diagram 2 from high-level system architecture, package.json6-16
Understanding the repository structure requires knowing where critical configuration and source files are located.
| Purpose | File Path | Description |
|---|---|---|
| Application Entry | docs/index.html | Production HTML with security headers |
| Main Component | src/App.tsx | Be component (main game) |
| Game State | src/hooks/useGameState.ts | ye hook implementation |
| Audio System | src/hooks/useAudio.ts | xe hook implementation |
| Build Config | vite.config.ts | Vite build configuration |
| Test Config | vitest.config.ts | Vitest unit test configuration |
| E2E Config | cypress.config.ts | Cypress E2E configuration |
| TypeScript | tsconfig.json, tsconfig.app.json, tsconfig.node.json | TypeScript compiler options |
| Package Manifest | package.json | Dependencies and scripts |
| CI/CD Workflows | .github/workflows/*.yml | GitHub Actions workflows |
| Copilot Config | .github/copilot-instructions.md | AI assistance guidelines |
| Custom Agents | .github/agents/*.md | Specialized Copilot agents |
| Agent Skills | .github/skills/*/SKILL.md | Reusable agent patterns |
| Security Policy | SECURITY.md | Vulnerability reporting |
| ISMS Mapping | docs/ISMS_POLICY_MAPPING.md | Policy compliance mapping |
Sources: package.json1-57 docs/index.html1-39 README.md1-700
The repository follows semantic versioning with automated release management.
Current Version: 1.2.32
Version Location: package.json4
Version File: docs/version.txt1
Release Workflow: .github/workflows/release.yml
Deployment Target: GitHub Pages (https://hack23.github.io/game/)
The version number is automatically incremented during the release process and embedded in build artifacts with cryptographic attestations for supply chain verification.
Sources: package.json4 docs/version.txt1 README.md627-743
The repository demonstrates compliance with multiple industry standards and frameworks through automated validation and transparent documentation.
Framework: Hack23 AB Information Security Management System (ISMS)
Standards: ISO 27001:2022, NIST CSF 2.0, CIS Controls v8.1
Policies Applied: 10 core policies (see ISMS Compliance)
Mapping Document: docs/ISMS_POLICY_MAPPING.md
Public ISMS: https://github.com/Hack23/ISMS-PUBLIC
OSSF Scorecard Target: ≥8.0/10
SLSA Level: Level 3 (Build Provenance)
SBOM Quality Target: ≥7.0/10
Test Coverage Target: ≥80% (≥95% for security code)
License Compliance: MIT, Apache-2.0, BSD variants, ISC, CC0-1.0, Unlicense only
Sources: README.md11-42 SECURITY.md24-150 docs/ISMS_POLICY_MAPPING.md1-500
The fastest way to start developing with this template is through GitHub Codespaces, which provides a pre-configured environment with all dependencies and tools installed.
Quick Start Commands:
GitHub Codespaces:
For detailed setup instructions, see Getting Started.
Sources: package.json6-16 README.md457-481 README.md199-238
For in-depth information on specific aspects of the system, consult these wiki pages:
External documentation:
Sources: README.md1-743 SECURITY.md1-400 docs/ISMS_POLICY_MAPPING.md1-500
Refresh this wiki