Skip to content
This repository was archived by the owner on Jul 31, 2026. It is now read-only.

README.md

Latest commit

 

History

History
137 lines (86 loc) · 3.04 KB

README.md

File metadata and controls

137 lines (86 loc) · 3.04 KB
Raw

Chess Variant Simulator

A web application for simulating and playing various chess variants. Built with modern web technologies to provide an interactive and educational chess experience.

Features

  • Interactive chess variant gameplay
  • Modern, responsive user interface
  • Type-safe codebase with TypeScript
  • State management with Pinia
  • Routing capabilities for multi-view application

Tech Stack

Core Framework & Language

  • Vue 3 - Progressive JavaScript framework with Composition API
  • TypeScript - Static type checking and enhanced developer experience

Build Tools & Development

  • Vite - Lightning-fast build tool and development server
  • Vue DevTools - Browser extension for debugging Vue applications

State Management & Routing

  • Pinia - Intuitive, type-safe state management for Vue
  • Vue Router - Official routing library for Vue.js

Code Quality & Linting

  • ESLint - Pluggable linting utility for JavaScript and TypeScript
  • Oxlint - Fast Rust-based linter for additional validation
  • Prettier - Opinionated code formatter

Testing

  • Vitest - Fast unit testing framework powered by Vite
  • Cypress - End-to-end testing framework
  • Vue Test Utils - Official testing utilities for Vue components
  • jsdom - JavaScript implementation of web standards for Node.js

Additional Tools

  • vue-tsc - TypeScript compiler wrapper for Vue SFC type checking
  • npm-run-all2 - CLI tool for running multiple npm scripts

Requirements

  • Node.js: >=22.12.0

Project Setup

Install dependencies:

npm install

Development

Start Development Server

Run the application with hot-reload for development:

npm run dev

The development server will start at http://localhost:5173 (or another port if 5173 is in use).

Type Checking

Run TypeScript type checking:

npm run type-check

Code Linting & Formatting

Lint and auto-fix code issues:

npm run lint

Format code with Prettier:

npm run format

Running Tests

Unit Tests

Run unit tests with Vitest:

npm run test:unit

End-to-End Tests

Run E2E tests in development mode (with Cypress UI):

npm run test:e2e:dev

Run E2E tests against production build (headless):

npm run build
npm run test:e2e

Production

Build for Production

Type-check, compile, and minify for production:

npm run build

The production-ready files will be generated in the dist directory.

Preview Production Build

Preview the production build locally:

npm run preview