Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on macOS
The most customizable typing website with a minimalistic design and a ton of features. Test yourself in various modes, track your progress and improve your speed.
Saved setup from 1 h ago
Will it work on macOS?
Heads-upBuilding it yourself? It also needs MongoDB, Redis and 16 settings in .env (3 secret).
The maintainers included scripts/setup-worktree.sh. Run it from the cloned folder after reading it.
bash scripts/setup-worktree.sh
docs/CONTRIBUTING.mdWhen contributing to Monkeytype, it's good to know our best practices, tips, and tricks. First, Monkeytype is written in ~~JavaScript~~ TypeScript, HTML, and CSS (in order of language usage within the project); thus, we assume you are comfortable with these languages or have basic knowledge of them. Our backend is in NodeJS and we use MongoDB to store our user data. Firebase is used for authentication. Redis is used to store ephemeral data (daily leaderboards, jobs via BullMQ, OAuth state parameters). Furthermore, we use Oxc (Oxfmt and Oxlint) to format and lint our code.
We have two separate contribution guides based on what you're looking to contribute. If you're simply looking to help us augment our language or quotes data, please refer to CONTRIBUTING_BASIC.md. This guide will go over how to do so easily and without the need to set up a local development server.
If you're looking to make deeper code changes that affect functionality, or will require screenshots of the changes, please refer to CONTRIBUTING_ADVANCED.md.
Below is a set of general guidelines for different types of changes.
We use Conventional Commits for our pull request titles (and commit messages on the master branch) and also include the author name at the end inside parenthesis. Please follow the guidelines below when naming pull requests.
For types, we use the following:
feat: A new featureimpr: An improvement to an existing featurefix: A bug fixdocs: Documentation only changesstyle: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc)refactor: A code change that neither fixes a bug nor adds a feature, but makes the code easier to read, understand, or improveperf: A code change that improves performancetest: Adding missing tests or correcting existing testsbuild: Changes that affect the build system or external dependencies (example scopes: vite, tsup-node, npm)ci: Changes to our CI configuration files and scripts (example scopes: GitHub Workflows)revert: Reverts a previous commitchore: Other changes that don't apply to any of the abovefeat: add new feature (@github_username)impr(quotes): add english quotes (@username)fix(leaderboard): show user rank correctly (@user1, @user2, @user3)Before submitting a theme make sure...
_list file and the textColor property is the theme's main colorflip test colors and colorful mode enabled and disabledIf you want to contribute themes but don't know how, check THEMES.md
_list and _groups fileslanguageName.json is 200 words, languageName_1k.json is 1000 words, and so on)If you want to contribute languages but don't know how, check LANGUAGES.md
length property is correct (length of the text in characters)id property is incremented correctlyFrench, your pull request should be named impr(quotes): add French quotes (@yourusername).If you want to contribute quotes but don't know how, check QUOTES.md
If you want to contribute layouts but don't know how, check LAYOUTS.md
If you have any questions, comments, concerns, or problems let me know on GitHub, Discord in the #development channel, or ask a question on Monkeytype's GitHub discussions and a contributor will be happy to assist you.
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/monkeytypegame/monkeytype.git cd monkeytype
Node.js 24.22.1
# needs nvm: brew install nvm (or https://github.com/nvm-sh/nvm) nvm install nvm use
Needs: MongoDB, Redis (no compose file — install locally or run via Docker)
corepack enable pnpm install
pnpm dev
pnpm test
No reports for macOS yet.
GitManual AI Agent reads the 14 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.