Skip to content

README.md

Latest commit

 

History

History
37 lines (33 loc) · 1.42 KB

README.md

File metadata and controls

37 lines (33 loc) · 1.42 KB

Typing Titans

Overview

  • Take typing tests to determine your WPM (words per minute) and accuracy
  • Choose from a variety of tests with varying durations and difficulties
  • Your scores are automatically saved so you can see how you compare to other users

Features

  • Save user scores
  • Ranking/Leaderboard page
  • Extensible level system
  • Light and dark modes
  • User profile page
  • User leveling system
  • Level difficulty rating (Flesch Kincaid readibility tests)
  • Per-level leaderboards

A guide to the subdirectories

  • test - where the user takes a test from the selected level
  • level - level selection page
  • libs - miscellaenous libraries needed for other pages
  • login - pages for user login and registration
  • ranking - user rankings page(s)
  • home - website homepage
  • util - miscellaneous utility scripts

Running from source

  • Clone the repo with git clone https://github.com/reddign/typing.git
  • Create a file in the libs directory called dbcreds.ini with the following contents (replace the temporary values with valid ones)
# Credentials used to connect to the MySQL database
ip = "database.ip.address"
schema = "schema-with-needed-tables"
username = "your_username"
password = "your password"
  • Start the webserver of your choosing and navigate to the project's url