### Install and Run Monkeytype Locally

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Clone the repository, install dependencies using pnpm, and start the development server for full-stack or individual backend/frontend hot-reloading.

```bash
# Clone and install
git clone https://github.com/monkeytypegame/monkeytype.git
cd monkeytype
pnpm install

# Start full dev stack (frontend + backend hot-reload)
pnpm dev

# Backend only
pnpm dev-be

# Frontend only
pnpm dev-fe

# Run tests
pnpm test

# Build production artifacts
pnpm build
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Run this command in the project root to install all necessary dependencies for both frontend and backend if running manually.

```bash
pnpm i
```

--------------------------------

### Start Backend Database with Docker

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Starts the backend database services using Docker. This command should be run from the ./backend directory.

```bash
npm run docker-db-only
```

--------------------------------

### Install Firebase CLI

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Installs the Firebase Command Line Interface globally.

```bash
pnpm add -g firebase-tools
```

--------------------------------

### Initialize Challenge Setup

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Handles the overall process of setting up a challenge. This includes changing the UI page, fetching the challenge list, finding the specific challenge, and then calling the appropriate setup function based on the challenge type. It also includes error handling for challenges not found.

```javascript
export async function setup(challengeName) {
  challengeLoading = true;
  if (UI.getActivePage() !== "pageTest") {
    UI.changePage("", true);
  }

  let list = await Misc.getChallengeList();
  let challenge = list.filter((c) => c.name === challengeName)[0];
  let notitext;
  try {
    if (challenge === undefined) {
      Notifications.add("Challenge not found", 0);
      ManualRestart.set();
      TestLogic.restart(false, true);
      setTimeout(() => {
        $("#top .config").removeClass("hidden");
        $(".page.pageTest").removeClass("hidden");
      }, 250);
      return;
    }
    if (challenge.type === "customTime") {
      UpdateConfig.setTimeConfig(challenge.parameters[0], true);
      UpdateConfig.setMode("time", true);
      UpdateConfig.setDifficulty("normal", true);
      if (challenge.name === "englishMaster") {
        UpdateConfig.setLanguage("english_10k", true);
        UpdateConfig.setNumbers(true, true);
        UpdateConfig.setPunctuation(true, true);
      }
    } else if (challenge.type === "customWords") {
      UpdateConfig.setWordCount(challenge.parameters[0], true);
      UpdateConfig.setMode("words", true);
      UpdateConfig.setDifficulty("normal", true);
    } else if (challenge.type === "customText") {
      CustomText.setText(challenge.parameters[0].split(" "));
      CustomText.setIsWordRandom(challenge.parameters[1]);
      CustomText.setWord(parseInt(challenge.parameters[2]));
      UpdateConfig.setMode("custom", true);
      UpdateConfig.setDifficulty("normal", true);
    } else if (challenge.type === "script") {
      let scriptdata = await fetch("/challenges/" + challenge.parameters[0]);
      scriptdata = await scriptdata.text();
      let text = scriptdata.trim();
      text = text.replace(/[

t ]/gm, " ");
      text = text.replace(/ +/gm, " ");
      CustomText.setText(text.split(" "));
      CustomText.setIsWordRandom(false);
      UpdateConfig.setMode("custom", true);
      UpdateConfig.setDifficulty("normal", true);
      if (challenge.parameters[1] != null) {
        UpdateConfig.setTheme(challenge.parameters[1]);
      }
      if (challenge.parameters[2] != null) {
        Funbox.activate(challenge.parameters[2]);
      }
    } else if (challenge.type === "accuracy") {
      UpdateConfig.setTimeConfig(0, true);
      UpdateConfig.setMode("time", true);
      UpdateConfig.setDifficulty("master", true);
    } else if (challenge.type === "funbox") {
      UpdateConfig.setFunbox(challenge.parameters[0], true);
      UpdateConfig.setDifficulty("normal", true);
      if (challenge.parameters[1] === "words") {
        UpdateConfig.setWordCount(challenge.parameters[2], true);
      } else if (challenge.parameters[1] === "time") {
        UpdateConfig.setTimeConfig(challenge.parameters[2], true);
      }
      UpdateConfig.setMode(challenge.parameters[1], true);
    }
  } catch (e) {
    console.error(e);
    Notifications.add(
      `Something went wrong when setting up challenge: ${e.message}`,
      0
    );
  }
}
```

--------------------------------

### Firebase Project Configuration Example

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Example content for the .firebaserc file, specifying the default Firebase project ID.

```json
{
    "projects": {
        "default": "your-firebase-project-id"
    }
}
```

--------------------------------

### Install Specific Node.js Version with NVM

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Installs a specific version of Node.js using NVM.

```bash
nvm install 24.11.0
nvm use 24.11.0
```

--------------------------------

### Preset API Route Setup

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Configures the API routes for managing user presets. It supports getting, adding, editing, and removing presets, each protected by specific rate limits and requiring authentication.

```javascript
const { authenticateRequest } = require("../../middlewares/auth");
const PresetController = require("../controllers/preset");
const RateLimit = require("../../middlewares/rate-limit");

const { Router } = require("express");

const router = Router();

router.get(
  "/",
  RateLimit.presetsGet,
  authenticateRequest,
  PresetController.getPresets
);

router.post(
  "/add",
  RateLimit.presetsAdd,
  authenticateRequest,
  PresetController.addPreset
);

router.post(
  "/edit",
  RateLimit.presetsEdit,
  authenticateRequest,
  PresetController.editPreset
);

router.post(
  "/remove",
  RateLimit.presetsRemove,
  authenticateRequest,
  PresetController.removePreset
);

module.exports = router;
```

--------------------------------

### Install PNPM Globally

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Installs the PNPM package manager globally with a specific version.

```bash
npm i -g pnpm@10.28.1
```

--------------------------------

### Run Backend Only with Docker

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Starts the backend server using Docker.

```bash
cd backend && npm run docker
```

--------------------------------

### Configure Firebase Project

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Sets up the .firebaserc file by copying the example and updating the project ID.

```bash
firebase projects:list
```

--------------------------------

### Install and Use Specific Node.js Version with NVM

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Installs and switches to the Node.js version specified in the .nvmrc file using NVM.

```bash
nvm install
nvm use
```

--------------------------------

### Run Frontend Only with Docker

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Starts the frontend development server using Docker.

```bash
cd frontend && npm run docker
```

--------------------------------

### Run Frontend Only Manually

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Starts only the frontend development server.

```bash
npm run dev-fe
```

--------------------------------

### Run Backend Only Manually

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Starts only the backend development server.

```bash
npm run dev-be
```

--------------------------------

### Show Configuration Panel with Animation

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Displays the configuration panel with a fade-in animation. Ensures any previous animations are stopped before starting a new one.

```javascript
export function show() {
  $("#top .config")
    .stop(true, true)
    .removeClass("hidden")
    .css("opacity", 0)
    .animate(
      {
        opacity: 1,
      },
      125
    );
}
```

--------------------------------

### Get User Configuration

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Retrieves a user's configuration settings from the database. Returns null if no configuration is found.

```javascript
static async getConfig(uid) {
    let config = await mongoDB().collection("configs").findOne({ uid });
    // if (!config) throw new MonkeyError(404, "Config not found");
    return config;
  }
```

--------------------------------

### Get Paginated Results for a User

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Retrieves a paginated list of results for a given user from the 'results' collection. Results are sorted by timestamp in descending order. Supports 'start' and 'end' parameters for pagination, defaulting to 0 and 1000 respectively. Throws an error if no results are found.

```javascript
static async getResults(uid, start, end) {
    start = start ?? 0;
    end = end ?? 1000;
    const result = await mongoDB()
      .collection("results")
      .find({ uid })
      .sort({ timestamp: -1 })
      .skip(start)
      .limit(end)
      .toArray(); // this needs to be changed to later take patreon into consideration
    if (!result) throw new MonkeyError(404, "Result not found");
    return result;
  }
```

--------------------------------

### Copy Backend Environment Example

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Copy the example.env file to .env in the backend directory to configure Docker database ports. Adjust DOCKER_DB_PORT, DOCKER_REDIS_PORT, and DOCKER_SERVER_PORT if these ports are already in use.

```bash
cp example.env .env
```

--------------------------------

### Set Test Start Time (JavaScript)

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Sets the start timestamp for the typing test.

```javascript
export function setStart(s) {

```

--------------------------------

### Configure Backend Environment Variables

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Set up the `.env` file in the `backend/` directory with necessary credentials for MongoDB, Redis, and Firebase. An example file is provided for reference.

```bash
cp backend/example.env backend/.env
# Edit backend/.env with:
# MONGO_URI=mongodb://localhost:27017/monkeytype
# REDIS_URI=redis://localhost:6379
# FIREBASE_PROJECT_ID=...
# FIREBASE_CLIENT_EMAIL=...
# FIREBASE_PRIVATE_KEY=...
```

--------------------------------

### Initialize Test Environment

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Sets up the testing environment by resetting state, updating configuration based on language support, and determining the number of words to display based on various modes and settings.

```javascript
export async function init() {
  setActive(false);
  Replay.stopReplayRecording();
  words.reset();
  TestUI.setCurrentWordElementIndex(0);
  // accuracy = {
  //   correct: 0,
  //   incorrect: 0,
  // };

  input.resetHistory();
  input.resetCurrent();

  let language = await Misc.getLanguage(Config.language);
  if (language && language.name !== Config.language) {
    UpdateConfig.setLanguage("english");
  }

  if (!language) {
    UpdateConfig.setLanguage("english");
    language = await Misc.getLanguage(Config.language);
  }

  if (Config.lazyMode === true && language.noLazyMode) {
    Notifications.add("This language does not support lazy mode.", 0);
    UpdateConfig.setLazyMode(false);
  }

  let wordsBound = 100;
  if (Config.showAllLines) {
    if (Config.mode === "quote") {
      wordsBound = 100;
    } else if (Config.mode === "custom") {
      if (CustomText.isWordRandom) {
        wordsBound = CustomText.word;
      } else if (CustomText.isTimeRandom) {
        wordsBound = 100;
      } else {
        wordsBound = CustomText.text.length;
      }
    } else if (Config.mode != "time") {
      wordsBound = Config.words;
    }
  } else {
    if (Config.mode === "words" && Config.words < wordsBound) {
      wordsBound = Config.words;
    }
    if (
      Config.mode == "custom" &&
      CustomText.isWordRandom &&
      CustomText.word < wordsBound
    ) {
      wordsBound = CustomText.word;
    }
    if (Config.mode == "custom" && CustomText.isTimeRandom) {
      wordsBound = 100;
    }
    if (
      Config.mode == "custom" &&
      !CustomText.isWordRandom &&
      !CustomText.isTimeRandom &&
      CustomText.text.length < wordsBound
    ) {
      wordsBound = CustomText.text.length;
    }
  }

  if (
    (Config.mode === "custom" &&
      CustomText.isWordRandom &&
      CustomText.word == 0) ||
    (Config.mode === "custom" &&
      CustomText.isTimeRandom &&
      CustomText.time == 0)
  ) {
    wordsBound = 100;
  }

  if (Config.mode === "words" && Config.words === 0) {
    wordsBound = 100;
  }
  if (Config.funbox === "plus_one") {
    wordsBound = 2;
    if (Config.mode === "words" && Config.words < wordsBound) {
      wordsBound = Config.words;
    }
  }
  if (Config.funbox === "plus_two") {
    wordsBound = 3;
    if (Config.mode === "words" && Config.words < wordsBound) {
      wordsBound = Config.words;
    }
  }

  if (
    (Config.mode == "time" ||
      Config.mode == "words" ||
      Config.mode == "custom")
  ) {
    let wordList = language.words;
    if (Config.mode == "custom") {

```

--------------------------------

### GET /users/stats — Get typing statistics

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves overall typing statistics for the user.

```APIDOC
## GET /users/stats — Get typing statistics

### Description
Retrieves overall typing statistics for the user.

### Method
GET

### Endpoint
https://api.monkeytype.com/users/stats

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Typing statistics.
  - **completedTests** (integer) - Number of completed tests.
  - **startedTests** (integer) - Number of started tests.
  - **timeTyping** (integer) - Total time spent typing in seconds.
```

--------------------------------

### Configure Frontend Environment Variables

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Create a .env file in the frontend directory to specify the backend URL for network access. Replace <Your IP> with your machine's IP address.

```bash
BACKEND_URL="http://<Your IP>:5005"
```

--------------------------------

### GET /users — Get current user data

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves data for the currently authenticated user.

```APIDOC
## GET /users — Get current user data

### Description
Retrieves data for the currently authenticated user.

### Method
GET

### Endpoint
https://api.monkeytype.com/users

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - User data.
  - **name** (string) - Username.
  - **email** (string) - User's email.
  - **uid** (string) - User's unique ID.
  - **completedTests** (integer) - Number of completed tests.
  - **startedTests** (integer) - Number of started tests.
  - **timeTyping** (integer) - Total time spent typing in seconds.
  - **inboxUnreadSize** (integer) - Number of unread messages in the inbox.
  - **streak** (object) - User's current streak information.
    - **length** (integer) - Current streak length.
    - **lastResultTimestamp** (integer) - Timestamp of the last result.
    - **maxLength** (integer) - Maximum streak length achieved.
```

--------------------------------

### Setup Script-Based Challenge

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Sets up a challenge using a script file. Use this when the challenge type is 'script'. It fetches the script content, processes it into words, and sets the mode and difficulty. Optionally, it can set a theme and activate a funbox.

```javascript
else if (challenge.type === "script") {
      let scriptdata = await fetch("/challenges/" + challenge.parameters[0]);
      scriptdata = await scriptdata.text();
      let text = scriptdata.trim();
      text = text.replace(/[

t ]/gm, " ");
      text = text.replace(/ +/gm, " ");
      CustomText.setText(text.split(" "));
      CustomText.setIsWordRandom(false);
      UpdateConfig.setMode("custom", true);
      UpdateConfig.setDifficulty("normal", true);
      if (challenge.parameters[1] != null) {
        UpdateConfig.setTheme(challenge.parameters[1]);
      }
      if (challenge.parameters[2] != null) {
        Funbox.activate(challenge.parameters[2]);
      }
    }
```

--------------------------------

### GET /users/streak — Get user streak

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves information about the user's current typing streak.

```APIDOC
## GET /users/streak — Get user streak

### Description
Retrieves information about the user's current typing streak.

### Method
GET

### Endpoint
https://api.monkeytype.com/users/streak

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Streak information.
  - **length** (integer) - Current streak length.
  - **maxLength** (integer) - Maximum streak length achieved.
  - **lastResultTimestamp** (integer) - Timestamp of the last result contributing to the streak.
```

--------------------------------

### Run Frontend and Backend Manually

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docs/CONTRIBUTING_ADVANCED.md

Starts the local development website on port 3000 and the development server on port 5005. The website and server will automatically rebuild on changes in the src/ directory.

```bash
npm run dev
```

--------------------------------

### GET /users/testActivity — Get yearly test activity heatmap

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves data for a yearly test activity heatmap.

```APIDOC
## GET /users/testActivity — Get yearly test activity heatmap

### Description
Retrieves data for a yearly test activity heatmap.

### Method
GET

### Endpoint
https://api.monkeytype.com/users/testActivity

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Yearly test activity data, where keys are years and values are objects mapping days of the year to test counts.
```

--------------------------------

### Core API Route Setup

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Sets up a basic API route for core functionalities, specifically a POST endpoint for '/test'. This route requires user authentication.

```javascript
const { authenticateRequest } = require("../../middlewares/auth");
const { Router } = require("express");

const router = Router();

router.post("/test", authenticateRequest);

module.exports = router;
```

--------------------------------

### Initialize Test UI and Settings

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Resets UI elements, applies configuration settings based on 'funbox' mode, and initializes test components. Handles different game modes and special configurations.

```javascript
TestUI.focusWords();
      $("#monkey .fast").stop(true, true).css("opacity", 0);
      $("#monkey").stop(true, true).css({ animationDuration: "0s" });
      $("#typingTest").css("opacity", 0).removeClass("hidden");
      $("#wordsInput").val(" ");
      let shouldQuoteRepeat = false;
      if (
        Config.mode === "quote" &&
        Config.repeatQuotes === "typing" &&
        failReason !== ""
      ) {
        shouldQuoteRepeat = true;
      }
      if (Config.funbox === "arrows") {
        UpdateConfig.setPunctuation(false, true);
        UpdateConfig.setNumbers(false, true);
      } else if (Config.funbox === "58008") {
        UpdateConfig.setNumbers(false, true);
      } else if (Config.funbox === "specials") {
        UpdateConfig.setPunctuation(false, true);
        UpdateConfig.setNumbers(false, true);
      } else if (Config.funbox === "ascii") {
        UpdateConfig.setPunctuation(false, true);
        UpdateConfig.setNumbers(false, true);
      }
      if (!withSameWordset && !shouldQuoteRepeat) {
        setRepeated(false);
        setPaceRepeat(repeatWithPace);
        setHasTab(false);
        await init();
        PaceCaret.init(nosave);
      } else {
        setRepeated(true);
        setPaceRepeat(repeatWithPace);
        setActive(false);
        Replay.stopReplayRecording();
        words.resetCurrentIndex();
        input.reset();
        if (Config.funbox === "plus_one" || Config.funbox === "plus_two") {
          Notifications.add(
            "Sorry, this funbox won't work with repeated tests.",
            0
          );
          await Funbox.activate("none");
        } else {
          await Funbox.activate();
        }
        TestUI.showWords();
        PaceCaret.init();
      }
      failReason = "";
      if (Config.mode === "quote") {
        setRepeated(false);
      }
      if (Config.keymapMode !== "off") {
        Keymap.show();
      } else {
        Keymap.hide();
      }
      document.querySelector("#miniTimerAndLiveWpm .wpm").innerHTML = "0";
      document.querySelector("#miniTimerAndLiveWpm .acc").innerHTML = "100%";
      document.querySelector("#miniTimerAndLiveWpm .burst").innerHTML = "0";
      document.querySelector("#liveWpm").innerHTML = "0";
      document.querySelector("#liveAcc").innerHTML = "100%";
      document.querySelector("#liveBurst").innerHTML = "0";

      if (Config.funbox === "memory") {
        Funbox.startMemoryTimer();
        if (Config.keymapMode === "next") {
          UpdateConfig.setKeymapMode("react");
        }
      }

      let mode2 = Misc.getMode2();
      let fbtext = "";
      if (Config.funbox !== "none") {
        fbtext = " " + Config.funbox;
      }
      $(".pageTest #premidTestMode").text(
        `${Config.mode} ${mode2} ${Config.language.replace(/_/g, " ")}${fbtext}`
      );
      $(".pageTest #premidSecondsLeft").text(Config.time);

      if (Config.funbox === "layoutfluid") {
        UpdateConfig.setLayout(
          Config.customLayoutfluid
            ? Config.customLayoutfluid.split("#")[0]
            : "qwerty",
          true
        );
        UpdateConfig.setKeymapLayout(
          Config.customLayoutfluid
            ? Config.customLayoutfluid.split("#")[0]
            : "qwerty",
          true
        );
        Keymap.highlightKey(
          words
            .getCurrent()
            .substring(input.current.length, input.current.length + 1)
            .toString()
            .toUpperCase()
        );
      }

      $("#result").addClass("hidden");
      $("#testModesNotice").removeClass("hidden").css({
        opacity: 1,
      });
      // resetPaceCaret();
      $("#typingTest")
        .css("opacity", 0)
        .removeClass("hidden")
        .stop(true, true)
        .animate(
          {
            opacity: 1,
          },
          125,
          () => {
            TestUI.setTestRestarting(false);
            // resetPaceCaret();
            PbCrown.hide();
            TestTimer.clear();
            if ($("#commandLineWrapper").hasClass("hidden"))
              TestUI.focusWords();
            // ChartController.result.update();
            TestUI.updateModesNotice();
            UI.setPageTransition(false);
            // console.log(TestStats.incompleteSeconds);
            // console.log(TestStats.restartCount);
          }
        );
    }
  );
}
```

--------------------------------

### Build Monkeytype Frontend Docker Image

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docker/BUILD.md

Use this command from the project root to build the frontend Docker image. It specifies the build context, Dockerfile location, and tags the image.

```bash
docker buildx build --progress=plain --no-cache -t  monkeytype/monkeytype-frontend:latest . -f  ./docker/frontend/Dockerfile
```

--------------------------------

### GET /users/personalBests — Get personal bests

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves the user's personal best records for different typing modes.

```APIDOC
## GET /users/personalBests — Get personal bests

### Description
Retrieves the user's personal best records for different typing modes.

### Method
GET

### Endpoint
https://api.monkeytype.com/users/personalBests

### Query Parameters
- **mode** (string) - Optional - The typing mode (e.g., "time", "words").
- **mode2** (string) - Optional - The specific mode setting (e.g., "60" for 60 seconds).
```

--------------------------------

### Build Task

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Executes the 'clean' task followed by the 'compile' task to prepare the project for deployment.

```javascript
task("build", series("clean", "compile"));
```

--------------------------------

### Set Burst Start Time

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Records the start time of a typing burst. Used for calculating typing speed during rapid sequences of words.

```javascript
export function setBurstStart(time) {
  currentBurstStart = time;
}
```

--------------------------------

### Get Public Service Announcement

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Fetches a public service announcement (PSA) from the database. This is a simple GET request to retrieve PSA data.

```javascript
const PsaDAO = require("../../dao/psa");

class PsaController {
  static async get(req, res, next) {
    try {
      let data = await PsaDAO.get();
      return res.status(200).json(data);
    } catch (e) {
      return next(e);
    }
  }
}

module.exports = PsaController;
```

--------------------------------

### Initialize Firebase with Emulator

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Initializes Firebase with emulator support. Ensure Firebase SDKs are loaded before this script.

```javascript
<!-- Initialize Firebase -->
<script src="/__/firebase/init.js?useEmulator=true'></script>
```

--------------------------------

### GET /users/:uidOrName/profile — Get public profile

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves the public profile information for a given user, identified by their UID or username.

```APIDOC
## GET /users/:uidOrName/profile — Get public profile

### Description
Retrieves the public profile information for a given user, identified by their UID or username.

### Method
GET

### Endpoint
https://api.monkeytype.com/users/:uidOrName/profile

### Parameters
#### Path Parameters
- **uidOrName** (string) - Required - The user's UID or username.

#### Query Parameters
- **isUid** (boolean) - Optional - Set to `true` if `uidOrName` is a UID, `false` otherwise (defaults to `false`).

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Public profile data.
  - **name** (string) - Username.
  - **personalBests** (object) - User's personal bests.
  - **typingStats** (object) - User's typing statistics.
```

--------------------------------

### Build Monkeytype Backend Docker Image

Source: https://github.com/monkeytypegame/monkeytype/blob/master/docker/BUILD.md

Use this command from the project root to build the backend Docker image. It specifies the build context, Dockerfile location, and tags the image.

```bash
docker buildx build --progress=plain --no-cache -t monkeytype/monkeytype-backend:latest . -f  ./docker/backend/Dockerfile
```

--------------------------------

### Configure Rate Limiting for Results

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Manages rate limits for various results-related endpoints, including GET, ADD, TAGS UPDATE, DELETE ALL, and LEADERBOARD GET requests, with varying limits.

```javascript
exports.resultsGet = rateLimit({
  windowMs: 60 * 60 * 1000, // 60 min
  max: 60 * multiplier,
  message,
  keyGenerator: getAddress,
});

exports.resultsAdd = rateLimit({
  windowMs: 60 * 60 * 1000,
  max: 500 * multiplier,
  message,
  keyGenerator: getAddress,
});

exports.resultsTagsUpdate = rateLimit({
  windowMs: 60 * 60 * 1000,
  max: 30 * multiplier,
  message,
  keyGenerator: getAddress,
});

exports.resultsDeleteAll = rateLimit({
  windowMs: 60 * 60 * 1000, // 60 min
  max: 10 * multiplier,
  message,
  keyGenerator: getAddress,
});

exports.resultsLeaderboardGet = rateLimit({
  windowMs: 60 * 60 * 1000, // 60 min
  max: 60 * multiplier,
  message,
  keyGenerator: getAddress,
});

exports.resultsLeaderboardQualificationGet = rateLimit({
  windowMs: 60 * 60 * 1000, // 60 min
  max: 60 * multiplier,
  message,
  keyGenerator: getAddress,
});
```

--------------------------------

### Rate Limiter for Config Gets

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Configures a rate limiter for configuration get endpoints. Allows 120 requests per hour per IP address, with a multiplier for development mode.

```javascript
exports.configGet = rateLimit({
  windowMs: 60 * 60 * 1000, // 60 min
  max: 120 * multiplier,
  message,
  keyGenerator: getAddress,
});
```

--------------------------------

### GET /public/typingStats

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves platform-wide typing statistics.

```APIDOC
## GET /public/typingStats

### Description
Retrieves overall platform statistics, such as the total number of completed tests and total time spent typing across all users. This is a public endpoint.

### Method
GET

### Endpoint
https://api.monkeytype.com/public/typingStats

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Platform-wide typing statistics.
  - **completedTests** (integer) - Total number of tests completed.
  - **timeTyping** (integer) - Total time spent typing in seconds.

#### Response Example
```json
{
  "message": "Typing stats retrieved",
  "data": {
    "completedTests": 12500000,
    "timeTyping": 620000000
  }
}
```
```

--------------------------------

### GET /leaderboards/xp/weekly

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves the weekly XP leaderboard.

```APIDOC
## GET /leaderboards/xp/weekly

### Description
Retrieves the weekly leaderboard based on Experience Points (XP).

### Method
GET

### Endpoint
https://api.monkeytype.com/leaderboards/xp/weekly

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of entries per page.

### Request Example
```bash
curl "https://api.monkeytype.com/leaderboards/xp/weekly?page=0&pageSize=50"
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Weekly XP leaderboard data.
  - **count** (integer) - Total number of entries.
  - **pageSize** (integer) - Number of entries per page.
  - **entries** (array) - Array of leaderboard entries.
    - **rank** (integer) - The rank of the user.
    - **name** (string) - The user's name.
    - **xp** (integer) - Experience points earned.
    - **uid** (string) - The user's unique identifier.

#### Response Example
```json
{
  "message": "Weekly XP leaderboard retrieved",
  "data": {
    "count": 5000,
    "pageSize": 50,
    "entries": [{ "rank": 1, "name": "xpGrinder", "xp": 8500, "uid": "..." }]
  }
}
```
```

--------------------------------

### Run Local Database Stack with Docker Compose

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Utilize Docker Compose to quickly set up a local MongoDB and Redis environment for backend development without manual installation.

```bash
cd backend
docker compose -f docker/compose.db-only.yml up -d
# Starts MongoDB + Redis locally
```

--------------------------------

### Show Command Line Interface

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Displays the command line interface and sets focus to the input field. It also handles the visual transition for showing the command line wrapper.

```javascript
export let show = () => {
  if (!$(".page.pageLoading").hasClass("hidden")) return;
  Focus.set(false);
  $("#commandLine").removeClass("hidden");
  $("#commandInput").addClass("hidden");
  if ($("#commandLineWrapper").hasClass("hidden")) {
    $("#commandLineWrapper")
      .stop(true, true)
      .css("opacity", 0)
      .removeClass("hidden")
      .animate(
        {
          opacity: 1,
        },
        100
      );
  }
  $("#commandLine input").val("");
  updateSuggested();
  $("#commandLine input").focus();
};
```

--------------------------------

### User API Route Setup

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Defines a comprehensive set of API routes for user management. Includes endpoints for retrieving user data, signup, name/email updates, leaderboard score clearing, tag management, and Discord linking/unlinking, all with appropriate rate limiting and authentication.

```javascript
const { authenticateRequest } = require("../../middlewares/auth");
const { Router } = require("express");
const UserController = require("../controllers/user");
const RateLimit = require("../../middlewares/rate-limit");

const router = Router();

router.get(
  "/",
  RateLimit.userGet,
  authenticateRequest,
  UserController.getUser
);

router.post(
  "/signup",
  RateLimit.userSignup,
  authenticateRequest,
  UserController.createNewUser
);

router.post("/checkName", RateLimit.userCheckName, UserController.checkName);

router.post(
  "/delete",
  RateLimit.userDelete,
  authenticateRequest,
  UserController.deleteUser
);

router.post(
  "/updateName",
  RateLimit.userUpdateName,
  authenticateRequest,
  UserController.updateName
);

router.post(
  "/updateLbMemory",
  RateLimit.userUpdateLBMemory,
  authenticateRequest,
  UserController.updateLbMemory
);

router.post(
  "/updateEmail",
  RateLimit.userUpdateEmail,
  authenticateRequest,
  UserController.updateEmail
);

router.post(
  "/clearPb",
  RateLimit.userClearPB,
  authenticateRequest,
  UserController.clearPb
);

router.post(
  "/tags/add",
  RateLimit.userTagsAdd,
  authenticateRequest,
  UserController.addTag
);

router.get(
  "/tags",
  RateLimit.userTagsGet,
  authenticateRequest,
  UserController.getTags
);

router.post(
  "/tags/clearPb",
  RateLimit.userTagsClearPB,
  authenticateRequest,
  UserController.clearTagPb
);

router.post(
  "/tags/remove",
  RateLimit.userTagsRemove,
  authenticateRequest,
  UserController.removeTag
);

router.post(
  "/tags/edit",
  RateLimit.userTagsEdit,
  authenticateRequest,
  UserController.editTag
);

router.post(
  "/discord/link",
  RateLimit.userDiscordLink,
  authenticateRequest,
  UserController.linkDiscord
);

router.post(
  "/discord/unlink",
  RateLimit.userDiscordUnlink,
  authenticateRequest,
  UserController.unlinkDiscord
);

module.exports = router;
```

--------------------------------

### GET /leaderboards/daily

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves the daily leaderboard for a specific day.

```APIDOC
## GET /leaderboards/daily

### Description
Retrieves the daily leaderboard for a specific day. You can fetch today's leaderboard or a past day's leaderboard using `daysBefore`.

### Method
GET

### Endpoint
https://api.monkeytype.com/leaderboards/daily

### Parameters
#### Query Parameters
- **language** (string) - Optional - The language of the leaderboard (e.g., 'english').
- **mode** (string) - Optional - The typing mode (e.g., 'time').
- **mode2** (string) - Optional - Secondary mode parameter (e.g., '60' for 60 seconds).
- **page** (integer) - Optional - The page number for pagination.
- **pageSize** (integer) - Optional - The number of entries per page.
- **daysBefore** (integer) - Optional - The number of days before today to fetch the leaderboard for (0 for today).

### Request Example
```bash
# Today's daily leaderboard
curl "https://api.monkeytype.com/leaderboards/daily?language=english&mode=time&mode2=60&page=0&pageSize=25"

# Yesterday's daily leaderboard
curl "https://api.monkeytype.com/leaderboards/daily?language=english&mode=time&mode2=60&page=0&daysBefore=1"
```
```

--------------------------------

### Start Monkeytype Test

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Initiates a new typing test. Logs test start to analytics and sets up various game components like replay recording, stats, and UI elements. Handles different configurations like 'memory' funbox mode and pace caret.

```javascript
export function startTest() {
  if (UI.pageTransition) {
    return false;
  }
  if (!Config.dbConfigLoaded) {
    UpdateConfig.setChangedBeforeDb(true);
  }
  try {
    if (firebase.auth().currentUser != null) {
      firebase.analytics().logEvent("testStarted");
    } else {
      firebase.analytics().logEvent("testStartedNoLogin");
    }
  } catch (e) {
    console.log("Analytics unavailable");
  }
  setActive(true);
  Replay.startReplayRecording();
  Replay.replayGetWordsList(words.list);
  TestStats.resetKeypressTimings();
  TimerProgress.restart();
  TimerProgress.show();
  $("#liveWpm").text("0");
  LiveWpm.show();
  LiveAcc.show();
  LiveBurst.show();
  TimerProgress.update(TestTimer.time);
  TestTimer.clear();

  if (Config.funbox === "memory") {
    Funbox.resetMemoryTimer();
    $("#wordsWrapper").addClass("hidden");
  }

  try {
    if (Config.paceCaret !== "off" || (Config.repeatedPace && isPaceRepeat))
      PaceCaret.start();
  } catch (e) {}
  //use a recursive self-adjusting timer to avoid time drift
  TestStats.setStart(performance.now());
  TestTimer.start();
  return true;
}
```

--------------------------------

### DOM Ready and Email Action Handling

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/src/email-handler.html

Initializes the application on DOM ready, retrieves email action parameters (mode, oobCode, continueUrl, lang), and dispatches to the appropriate handler based on the mode.

```javascript
onDOMReady(() => {
  try {
    // Get the action to complete.
    var mode = getParameterByName("mode");
    // Get the one-time code from the query parameter.
    var actionCode = getParameterByName("oobCode");
    // (Optional) Get the continue URL from the query parameter if available.
    var continueUrl = getParameterByName("continueUrl");
    // (Optional) Get the language code if available.
    var lang = getParameterByName("lang") || "en";
    
    if (!mode) {
      qs("main .preloader .icon")?.setHtml(
        `<i class="fas fa-fw fa-times"></i>`,
      );
      qs("main .preloader .text")?.setText("Mode parameter not found");
      return;
    }
    if (!actionCode) {
      qs("main .preloader .icon")?.setHtml(
        `<i class="fas fa-fw fa-times"></i>`,
      );
      qs("main .preloader .text")?.setText(
        `Action code parameter not found`,
      );
      return;
    }

    // Handle the user management action.
    switch (mode) {
      case "resetPassword":
        // Display reset password handler and UI.
        qs("#logo .text span")?.setText("Reset Password");
        document.title = "Reset Password | Monkeytype";
        showResetPassword();
        break;
      case "recoverEmail":
        // Display email recovery handler and UI.
        handleRecoverEmail(actionCode);
        break;
      case "verifyEmail":
        qs("#logo .text span")?.setText("Verify Email");
        document.title = "Verify Email | Monkeytype";
        // Display email verification handler and UI.
        handleVerifyEmail(actionCode, continueUrl);
        break;
      default:
        qs("main .preloader .icon")?.setHtml(
          `<i class="fas fa-fw fa-times"></i>`,
        );
        qs("main .preloader .text")?.setText("Invalid mode");
        console.error("no mode found");
        // Error: invalid mode.
    }
    qs("main .resetPassword .button")?.on("click", () => {
      handleResetPassword(actionCode, continueUrl);
    });
    qs("main .resetPassword input")?.on("keypress", (e) => {
      if (e.key === "Enter") handleResetPassword(actionCode, continueUrl);
    });
  } catch (e) {
    qs("main .preloader .icon")?.setHtml(
      `<i class="fas fa-fw fa-times"></i>`,
    );
    qs("main .preloader .text")?.setText(
      `Fatal error: ${e.message}. If this issue persists, please report it.`,
    );
  }
});
```

--------------------------------

### Get Tags

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Retrieves all tags associated with the user's account.

```APIDOC
## GET /getTags

### Description
Retrieves a list of all custom tags created by the user.

### Method
GET

### Endpoint
/getTags

### Response
#### Success Response (200)
- **tags** (array) - An array of tag objects, where each object contains the tag's ID and name.
```

--------------------------------

### GET /quotes/rating

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves the community rating and statistics for a specific quote.

```APIDOC
## GET /quotes/rating

### Description
Retrieves the community rating information for a given quote, including average rating and total number of ratings.

### Method
GET

### Endpoint
https://api.monkeytype.com/quotes/rating

### Parameters
#### Query Parameters
- **quoteId** (integer) - Required - The ID of the quote.
- **language** (string) - Required - The language of the quote (e.g., 'english').

### Request Example
```bash
curl -H "Authorization: Bearer <token>" \
  "https://api.monkeytype.com/quotes/rating?quoteId=42&language=english"
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Rating details for the quote.
  - **quoteId** (integer) - The ID of the quote.
  - **language** (string) - The language of the quote.
  - **average** (number) - The average community rating.
  - **ratings** (integer) - The total number of ratings received.
  - **totalRating** (integer) - The sum of all ratings.

#### Response Example
```json
{
  "message": "Rating retrieved",
  "data": {
    "quoteId": 42,
    "language": "english",
    "average": 4.2,
    "ratings": 150,
    "totalRating": 630
  }
}
```
```

--------------------------------

### Create New User - JavaScript

Source: https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/challenges/sourcecode.txt

Creates a new user in the system. It takes the user's name, email, and UID from the request and logs the user creation event.

```javascript
  static async createNewUser(req, res, next) {
    try {
      const { name } = req.body;
      const { email, uid } = req.decodedToken;
      await UsersDAO.addUser(name, email, uid);
      Logger.log("user_created", `${name} ${email}`, uid);
      return res.sendStatus(200);
    } catch (e) {
      return next(e);
    }
  }
```

--------------------------------

### GET /quotes/isSubmissionEnabled

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Checks if quote submission is currently enabled on the platform.

```APIDOC
## GET /quotes/isSubmissionEnabled

### Description
Checks the current status of quote submission functionality. Returns whether users are currently allowed to submit new quotes.

### Method
GET

### Endpoint
https://api.monkeytype.com/quotes/isSubmissionEnabled

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - Submission status.
  - **isEnabled** (boolean) - True if quote submission is enabled, false otherwise.

#### Response Example
```json
{
  "message": "Is submission enabled",
  "data": {
    "isEnabled": true
  }
}
```
```

--------------------------------

### List Presets

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves a list of named configuration presets available for the user. Each preset includes its ID, name, and associated configuration.

```bash
# List presets
curl -H "Authorization: Bearer <token>" https://api.monkeytype.com/presets
```

--------------------------------

### GET /public/speedHistogram

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

Retrieves a histogram of typing speeds across all users.

```APIDOC
## GET /public/speedHistogram

### Description
Retrieves a histogram showing the distribution of users' personal best typing speeds, grouped into 10 WPM buckets. This is a public endpoint.

### Method
GET

### Endpoint
https://api.monkeytype.com/public/speedHistogram

### Parameters
#### Query Parameters
- **language** (string) - Optional - The language for which to retrieve the speed histogram (e.g., 'english').
- **mode** (string) - Optional - The typing mode (e.g., 'time').
- **mode2** (string) - Optional - Secondary mode parameter (e.g., '60' for 60 seconds).

### Request Example
```bash
curl "https://api.monkeytype.com/public/speedHistogram?language=english&mode=time&mode2=60"
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **data** (object) - An object where keys are WPM ranges (e.g., '0', '10') and values are the count of users in that range.

#### Response Example
```json
{
  "message": "Speed histogram retrieved",
  "data": {
    "0": 120,
    "10": 850,
    "50": 4200,
    "100": 1300
  }
}
```
```

--------------------------------

### Manage named configuration presets

Source: https://context7.com/monkeytypegame/monkeytype/llms.txt

List available named configuration presets.

```APIDOC
## Manage named configuration presets

### List presets

#### Method
GET

#### Endpoint
https://api.monkeytype.com/presets

#### Request Headers
- Authorization: Bearer <token>
```