Skip to content

olllayor/typeracer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TypeRacer CLI

A command-line typing speed test game built with TypeScript. Test your typing speed and accuracy in a fun, competitive environment right from your terminal!

🚀 Features

  • Real-time typing speed measurement
  • Accuracy tracking
  • Clean, terminal-based interface
  • Multiple text samples to test against

📋 Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (version 14 or higher)
  • npm (comes with Node.js)

🛠️ Installation

  1. Clone the repository:
git clone https://github.com/yourusername/typeracer.git
cd typeracer
  1. Install dependencies:
npm install

🎮 How to Play

  1. Start the game:
npm start
  1. When the game starts:

    • A random text will appear
    • Start typing as soon as you see the text
    • Your typing speed and accuracy will be displayed in real-time
    • Press Enter when you're done
  2. After completing the text:

    • Your words per minute (WPM) will be displayed
    • Your accuracy percentage will be shown
    • You'll have the option to play again

🛠️ Development

To run the project in development mode:

npm run dev

To compile TypeScript files:

npm run build

📁 Project Structure

typeracer/
├── src/            # Source code
├── texts/          # Text samples for typing tests
├── package.json    # Project dependencies and scripts
└── tsconfig.json   # TypeScript configuration

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📝 License

This project is licensed under the ISC License.

🙏 Acknowledgments

  • Thanks to all contributors who have helped improve this project
  • Inspired by the classic TypeRacer game

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published