README.md

Type Racer

Typing skill assessment and tracked lifetime history of game statistics for users to refine typing proficiency and be able to have a comprehensive overview of their performance.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Usage
3. Getting Started
   • Installation
4. Contact
5. Acknowledgments

About The Project

A dynamic platform that allows assessment of user typing skills including typing speed (WPM) and incorrect character count. Sentences can be customized. The typing test history and statistics are updated and viewable in Game History to track typing progress!

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Usage

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Installation

1. Deploy a MongoDB database at https://mongodb.com

2. Clone the repo

   git clone https://github.com/pakuang/TypeRacer.git

3. Install NPM packages

   npm install

4. Enter your database connection string and local port in .env

    PORT= 
    DB_URL= 'Enter your connection string here'

5. Run the development server:

   npm run dev
   # or
   yarn dev
   # or
   pnpm dev
   # or
   bun dev

6. Open http://localhost:3000 with your browser to see the result.

(back to top)

Contact

Pansy Kuang - LinkedIn - kuangpansy@gmail.com

Project Link: https://github.com/pakuang/TypeRacer

(back to top)