mirror of
https://github.com/monkeytypegame/monkeytype.git
synced 2026-01-14 11:24:11 +08:00
8d42ae057e
### Description <!-- Please describe the change(s) made in your PR --> ### Checks - [ ] Adding/modifying Typescript code? - [ ] I have used `qs`, `qsa` or `qsr` instead of JQuery selectors. - [ ] Adding quotes? - [ ] Make sure to include translations for the quotes in the description (or another comment) so we can verify their content. - [ ] Adding a language? - Make sure to follow the [languages documentation](https://github.com/monkeytypegame/monkeytype/blob/master/docs/LANGUAGES.md) - [ ] Add language to `packages/schemas/src/languages.ts` - [ ] Add language to exactly one group in `frontend/src/ts/constants/languages.ts` - [ ] Add language json file to `frontend/static/languages` - [ ] Adding a theme? - Make sure to follow the [themes documentation](https://github.com/monkeytypegame/monkeytype/blob/master/docs/THEMES.md) - [ ] Add theme to `packages/schemas/src/themes.ts` - [ ] Add theme to `frontend/src/ts/constants/themes.ts` - [ ] Add theme css file to `frontend/static/themes` - [ ] Add some screenshots of the theme, especially with different test settings (colorful, flip colors) to your pull request - [ ] Adding a layout? - [ ] Make sure to follow the [layouts documentation](https://github.com/monkeytypegame/monkeytype/blob/master/docs/LAYOUTS.md) - [ ] Add layout to `packages/schemas/src/layouts.ts` - [ ] Add layout json file to `frontend/static/layouts` - [ ] Adding a font? - Make sure to follow the [themes documentation](https://github.com/monkeytypegame/monkeytype/blob/master/docs/FONTS.md) - [ ] Add font file to `frontend/static/webfonts` - [ ] Add font to `packages/schemas/src/fonts.ts` - [ ] Add font to `frontend/src/ts/constants/fonts.ts` - [ ] Check if any open issues are related to this PR; if so, be sure to tag them below. - [ ] Make sure the PR title follows the Conventional Commits standard. (https://www.conventionalcommits.org for more info) - [ ] Make sure to include your GitHub username prefixed with @ inside parentheses at the end of the PR title. <!-- label(optional scope): pull request title (@your_github_username) --> <!-- I know I know they seem boring but please do them, they help us and you will find out it also helps you.--> Closes #7186 <!-- the issue(s) your PR resolves if any (delete if that is not the case) --> <!-- please also reference any issues and or PRs related to your pull request --> <!-- Also remove it if you are not following any issues. --> <!-- pro tip: you can mention an issue, PR, or discussion on GitHub by referencing its hash number e.g: [#1234](https://github.com/monkeytypegame/monkeytype/pull/1234) --> <!-- pro tip: you can press . (dot or period) in the code tab of any GitHub repo to get access to GitHub's VS Code web editor Enjoy! :) -->
70 lines
7.1 KiB
Markdown
70 lines
7.1 KiB
Markdown
[](https://monkeytype.com/)
|
|
<br />
|
|
|
|
[](https://www.chartjs.org/)
|
|
[](https://eslint.org/)
|
|
[](https://expressjs.com/)
|
|
[](https://firebase.google.com/)
|
|
[](https://fontawesome.com/)
|
|
[](https://developer.mozilla.org/en-US/docs/Web/HTML)
|
|
[](https://www.mongodb.com/)
|
|
[](https://oxc.rs/docs/guide/usage/linter.html)
|
|
[](https://pnpm.io/)
|
|
[](https://redis.io/)
|
|
[](https://sass-lang.com/)
|
|
[](https://ts-rest.com/)
|
|
[](https://turborepo.org/)
|
|
[](https://www.typescriptlang.org/)
|
|
[](https://vitejs.dev/)
|
|
[](https://vitest.dev/)
|
|
[](https://zod.dev/)
|
|
|
|
# About
|
|
|
|
Monkeytype is a minimalistic and customizable [typing test](https://www.monkeytype.com). 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](https://www.discord.gg/monkeytype), 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](mailto:contact@monkeytype.com), [create an issue](https://github.com/monkeytypegame/monkeytype/issues), [create a discussion thread](https://github.com/monkeytypegame/monkeytype/discussions), or [join the Discord server](https://www.discord.gg/monkeytype).
|
|
|
|
# Want to Contribute?
|
|
|
|
Refer to [CONTRIBUTING.md](./docs/CONTRIBUTING.md).
|
|
|
|
# Code of Conduct
|
|
|
|
Before contributing to this repository, please read the [code of conduct](./docs/CODE_OF_CONDUCT.md).
|
|
|
|
# Security
|
|
|
|
To report a security vulnerability, please refer to [SECURITY.md](./docs/SECURITY.md).
|
|
|
|
# Credits
|
|
|
|
[Montydrei](https://www.reddit.com/user/montydrei) for the name suggestion.
|
|
|
|
Everyone who provided valuable feedback on the [original Reddit post](https://www.reddit.com/r/MechanicalKeyboards/comments/gc6wx3/experimenting_with_a_completely_new_type_of/) for the prototype of this website.
|
|
|
|
All of the [contributors](https://github.com/monkeytypegame/monkeytype/graphs/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](https://ko-fi.com/monkeytype), [become a Patron](https://www.patreon.com/monkeytype) or [buy a t-shirt](https://www.monkeytype.store/).
|