Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.17 KB

README.md

File metadata and controls

46 lines (32 loc) · 2.17 KB
Raw

TypeRush - Get Better at Typing!

TypeRush is a web app that helps you get faster and more accurate at typing.

🚀 Features

  • New Typing Tests Every Time: The app has lots of different texts to keep your practice interesting and challenging.
  • See Your Progress as You Type: You can watch your typing speed, how well you're doing, and your score update live.
  • Spot Your Mistakes Easily: If you type something wrong, it'll light up so you can see where you need to improve.
  • Caps Lock Warning: It tells you if you've accidentally left Caps Lock on to avoid errors.
  • Summary After Each Test: When you finish a test, you get a detailed report of your speed, score, and mistakes.
  • Keep Practicing: You can start new tests over and over to keep getting better.
  • Nice and Simple Design: The design is clean and easy to use, helping you focus on practicing.
  • Light and Dark Mode: Matches your system preference to make it easy on your eyes, day or night.

🛠️ Technologies

  • React.js
  • TypeScript
  • Zustand
  • CSS Modules
  • React Icons

📝 How It Works

TypeRush picks a passage for you to type. As you type, it keeps track of how fast and accurate you are, and how many points you get. It shows mistakes clearly and warns you about Caps Lock. After each round, you get a full breakdown of your performance to encourage you to keep improving.

🚦 Running the Project

To run the project in your local environment, follow these steps:

  1. Clone the repository to your local machine.
  2. Run npm install or yarn in the project directory to install the required dependencies.
  3. Run npm run start or yarn start to get the project started.
  4. Open http://localhost:5173 (or the address shown in your console) in your web browser to view the app.

💡 Improvements

  • Leaderboard: Add a leaderboard to make it more competitive.
  • Your Own Texts: Let you practice with whatever text you want.
  • More Stats: Offer detailed stats to show how you're improving over time.
  • User Accounts: Make accounts so you can pick up where you left off on any device.

🐞 Issues

  • Right now, it doesn't work well on phones.