Skip to content
CrowdinCrowdin Serverless Apps

Quick Start

Requirements

Section titled “Requirements”
  • Node.js ^22.19 || ^24 - 22.19 or newer within the 22.x line, or any 24.x
  • A Node.js package manager - the examples use pnpm, but npm or yarn work too
  • A Crowdin or Crowdin Enterprise account

Create your first app

Section titled “Create your first app”

  1. Install the CLI globally:

    Terminal window
    npm install --global @crowdin/serverless-apps-cli

    Or run it ad hoc with npx @crowdin/serverless-apps-cli <command>.

  2. Sign in with your Crowdin account:

    Terminal window
    crowdin-serverless-apps login

    The CLI opens the browser for sign-in and detects your Crowdin Enterprise organization automatically.

  3. Scaffold an app from a starter template and register it in Crowdin:

    Terminal window
    crowdin-serverless-apps create my-app
    cd my-app
    pnpm install

    create asks which of the two starter templates to use, scaffolds the project (manifest.json, src/, public/, locales/), registers the app in Crowdin, and links the folder to it via .env.

  4. Develop live inside Crowdin, with hot reload:

    Terminal window
    crowdin-serverless-apps dev

    Accept the prompt to point the app at your local server. While dev runs, your app inside Crowdin loads straight from your machine - everything you edit shows up instantly.

  5. See the app inside Crowdin - in another terminal, run:

    Terminal window
    crowdin-serverless-apps preview

    It opens the browser right at the app’s place in the Crowdin UI.

  6. Publish when you are ready:

    Terminal window
    crowdin-serverless-apps publish

    The CLI builds the app, uploads the bundle, and lets Crowdin serve it. Publishing does not change who can see the app.

Where to go next

Section titled “Where to go next”