Typing Race

Get Ready to Test Your Typing Skills with an Exciting Web Challenge!

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Welcome to our cutting-edge Typing Test Web! We are thrilled to present a fun and interactive platform that will put your typing skills to the ultimate test. Whether you're a seasoned typist looking to refine your speed and accuracy or a beginner aiming to improve, our website offers a wide range of engaging typing challenges for all levels. With a user-friendly interface and an extensive selection of texts, quotes, and passages, you can customize your typing experience to suit your preferences. Prepare to embark on a journey of self-improvement and enjoy the thrill of competing against yourself and others. Sharpen your fingers and get ready to type your way to success on our exciting typing test web!

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

npm

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/Khiem17204/typing-speed-app.git

2. Install NPM packages

   npm install

(back to top)

Usage

We provide users with 6 modes of typing, including 3 timed modes (15s, 30s, 45s), and 3 word-count modes (25w, 50w, 100w). We used ChartJS to keep track of users typing performance and provide a detailed record after each attempt:

We also provide an interactive and real-time user statistic page, ready for customization. Users can now edit their bios, update their github, and twitter. We plan to allow users to share their public page in the future.

   

(back to top)

Roadmap

• First Functional TypingRace Release
• Customizable Userpage
• Add customizable templates
• Add Racing Mode
• Multi-language Support
  • Vietnamese

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Our Team

Khiem Le*, Trung Dang*, Huy Cao, and Tung Nguyen are sophomores at the University of Massachusetts Amherst. They have been working on TypingRace from June 2023 to July 2023. The project is maintained on Khiem's public repository and is open for public contributions. Interested individuals can reach out to Khiem at ktle@umass.edu, to Trung at trungdangminh14012004@gmail.com, to Huy at caogiahuy615@gmail.com, and to Tung at tung051024@gmail.com.

(*) indicates an equivalent contribution to the project. Marked individuals maintain the right to first author the project

Acknowledgments

• I, Trung, would like to thank PedroTech, Scrimba, the ChartJS team, and alexandreanlim for providing helpful references throughout the process. Kudos to my team for the hard work 👏👏👏!
• I, Huy, thank FontAwesome for serving as a crucial part of our UI/UX development.
• I, Khiem, thank mom and dad

(back to top)