README.md

Typing Speed Test

• Typing Test
  • About
    • How to Typing Test
• Getting Started
  • Requirements
    • Installation
  • Roadmap
  • Contributing
  • License
  • Acknowledgments

About

How to Typing Test

This is a minimalistic, yet sleek design of a typing speed test. I counts the words per minute (wpm) typed, the accuracy rate, and it saves high scores in the user's browser via the localStorage function. This is a simple React page with Redux and a few animations, with a lot of room for improvement. Feel free to contribute.

Getting Started

Requirements

• git
  • You'll know you did it right if you can run git --version and you see a response like git version x.x.x
• Nodejs
  • You'll know you've installed nodejs right if you can run:
    • node --versionand get an ouput like: vx.x.x
• Yarn instead of npm
  • You'll know you've installed yarn right if you can run:
    • yarn --version And get an output like: x.x.x
    • You might need to install it with npm

Installation

1. Clone this repo:

git clone https://github.com/VidiHawk/typing-test
cd typing-test

2. Install dependencies

yarn

3. Start in your local environment:

yarn start

Your should now be able to see the webapp in your browser at http://localhost:3000/

(back to top)

Roadmap

• [] Display high scores on the home page and result page
• [] Add live wpm, and live errot count during the test
• [] Add additionnal texts
• [] Add support for typing in Chinese
• [] Add some seo friendly content at the bottom of the home page.
• [] Deploy to production

(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)

Contact

Hardhat - @HardhatHQ Patrick Collins - @patrickalphac

(back to top)

Acknowledgments

• Salman Shaikh from whose work this project was inspired.

(back to top)