Developer Documentation

Welcome to the LuaInTheWeb developer documentation. This directory contains all the information you need to contribute to the project.

Quick Links

• Getting Started - Set up your development environment
• Architecture - System design and component overview
• Coding Standards - Component patterns, CSS modules, TypeScript
• Testing Guide - TDD practices and testing standards
• Contributing - How to contribute to the project

Prerequisites

Before getting started, ensure you have:

• Node.js 18+ and npm 9+
• Git
• uv/uvx for Code-Index-MCP (required for Claude Code workflow)

See Getting Started for detailed setup instructions including MCP configuration.

Project Overview

LuaInTheWeb is a web-based Lua learning and practice platform that allows users to learn and execute Lua code directly in their browsers.

Tech Stack

• Frontend: React 19 + TypeScript 5.9
• Build Tool: Vite 7
• Lua Runtime: wasmoon (WebAssembly-based Lua)
• Code Editor: CodeMirror
• Terminal: xterm.js

Development Workflow

Branch Policy: Never commit directly to main. All changes go through branches and PRs.

1. Check the roadmap for current plans
2. Follow TDD practices (see Testing Guide)
3. Run mutation tests to verify test quality
4. Submit PR for review

Directory Structure

lua-learning-website/
├── src/
│   ├── components/     # React components
│   ├── hooks/          # Custom React hooks
│   ├── utils/          # Utility functions
│   ├── types/          # TypeScript type definitions
│   └── __tests__/      # Test files
├── public/             # Static assets
└── package.json        # Dependencies