TCS-Typer Documentation
Overview
Title: TCS Typer
Description: A web-based typing test application that allows users to improve their typing speed and accuracy through various tests. The application features a leaderboard, customizable settings, and dynamic quote generation for typing tests. It is designed specifically for theCoderSchool, a programming school located in Walnut Creek, California.
Getting Started
- Clone the repository to your local machine.
- Navigate to the project directory and run npm install to install dependencies.
- To start the development server, run npm start. This will serve the project on localhost with live reloading enabled.
Key Components
- TypingTest: The main class responsible for handling typing tests.
- Leaderboard: Manages leaderboard functionality between all students.
- Sound and Theme: Allows students to customize the page.
- User Sign In: Used for student sign in
Contributing
Refer to contribute.md for extra details on contributing
License
(Todo)