2df72cc692
### Description Improved the `docker/example.env` file to make it more beginner-friendly and easier to configure for self-hosters. Changes made: - Added section headers for clarity (e.g. Required Config, Firebase Config, etc.) - Clarified which settings are optional (Firebase, email, ports) - Added better inline comments explaining each env variable - Improved formatting and spacing for better readability --- ### Checks - [x] Make sure the PR title follows the Conventional Commits standard. - [ ] Adding quotes? (N/A) - [ ] Adding a language? (N/A) - [ ] Adding a theme? (N/A) - [ ] Adding a layout? (N/A) - [x] Check if any open issues are related – None that I found --- ### Closes N/A |
||
|---|---|---|
| .github | ||
| .husky | ||
| backend | ||
| docker | ||
| docs | ||
| frontend | ||
| packages | ||
| .dockerignore | ||
| .editorconfig | ||
| .eslintignore | ||
| .gitignore | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc | ||
| commitlint.config.cjs | ||
| LICENSE | ||
| monkeytype.code-workspace | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| turbo.json | ||
| vitest.config.js | ||
| vitest.workspace.json | ||
About
Monkeytype is a minimalistic and customizable typing test. It features many test modes, an account system to save your typing speed history, and user-configurable features such as themes, sounds, a smooth caret, and more. Monkeytype attempts to emulate a natural typing experience during a typing test by unobtrusively presenting the text prompts and displaying typed characters in place, providing straightforward, real-time feedback on typos, speed, and accuracy.
Features
- minimalistic design, with optional advertisements and focus mode while typing
- type what you see, see what you type
- live errors, wpm, and accuracy displays
- a variety of test lengths and languages
- punctuation and numbers modes
- quotes
- themes
- smooth caret
- account system
- challenges and just-for-fun test modifiers
- and much more
Discord bot
On the Monkeytype Discord server, we added a Discord bot to auto-assign optional roles based on typing performance and challenge completion. You can find its code over at https://github.com/monkeytypegame/monkeytype-bot.
Bug report or Feature request
If you encounter a bug or have a feature request, send us an email, create an issue, create a discussion thread, or join the Discord server.
Want to Contribute?
Refer to CONTRIBUTING.md.
Code of Conduct
Before contributing to this repository, please read the code of conduct.
Security
To report a security vulnerability, please refer to SECURITY.md.
Credits
Montydrei for the name suggestion.
Everyone who provided valuable feedback on the original Reddit post for the prototype of this website.
All of the contributors have helped implement various features, add themes, fix bugs, and more.
Support
If you wish to support further development and feel extra awesome, you can donate, become a Patron or buy a t-shirt.