hausemasterz / swift-type Goto Github PK

Visit the site here: SwiftType.

SwiftType is a minimalistic typing test site that allows you to test your typing speed and accuracy. It features a simple and minimal interface, with the ability to toggle dark and light theme. Uses Quotable API to fetch random quotes.

Contributions are welcome! Please read CONTRIBUTING.md for more info.

• Blazingly fast
• Custom fonts
• Dark/Light Theme
• Calculates Current WPM, Gross WPM, Net WPM, Raw WPM, accuracy, errors, time taken
• Shortcut for fast restart and repeat
• Input field auto clear
• Result highlighting
• Word highlighting (on | off)
• Smooth caret (on | off)
• Control + Backspace delete
• Account support with tracking of scores

To build and test the site locally, follow these steps:

1. Clone the repository to your local machine.
2. Install the necessary dependencies by running npm install
3. Create a new file in the root directory of the project called .env.local
4. Add the necessary environment variables to the file in the format VARIABLE_NAME=value
5. To build the project, run the command npm run build.
6. To start the development server, run the command npm run server or npm start to use Create React App Deployment.
7. Open your web browser and navigate to http://localhost:3000 to view the site.
8. To run the tests, open a new terminal window and navigate to the project directory.
9. Run the command npm test to run the test suite.

Make sure to add the .envlocal file to your .gitignore file to prevent it from being tracked by Git.