Skip to content

README.md

Latest commit

 

History

History
47 lines (29 loc) · 1.49 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.49 KB

Codebreaker

Overview

Codebreaker is an engaging web-based game that demonstrates modern web development techniques and best practices. Built with TypeScript, React, and Next.js, this project showcases:

  • Strong typing and code safety with TypeScript
  • Interactive and responsive UI design with React
  • Server-side rendering and efficient routing with Next.js
  • Custom game logic implementation

In Codebreaker, players attempt to guess a hidden code, receiving feedback after each attempt. This project serves as both an entertaining game and a demonstration of clean, maintainable code architecture.

Live Demo

Link to live demo

Key Features

  • Customisable game parameters (code length, available symbols, number of attempts)
  • Instant feedback on player guesses
  • Responsive design for seamless play across devices
  • Extensible core logic, allowing for easy creation of game variations

Getting Started

Prerequisites

  • Node.js (v14 or later)
  • npm or yarn

Installation

  1. Clone the repository: git clone https://github.com/YourUsername/codebreaker.git
  2. Navigate to the project directory: cd codebreaker
  3. Install dependencies: npm install or yarn install

Running the Development Server

  1. Start the development server: npm run dev or yarn dev

  2. Open http://localhost:3000 in your browser to play the game.

Acknowledgments

  • Inspired by the classic Mastermind board game
  • Built with Next.js