Docs
Getting Started

Getting Started

Installation

npm install evolu

Note Evolu uses several peer dependencies that are installed automatically with NPM and PNPM. If you are using Yarn, install them manually. Evolu uses and recommends PNPM (opens in a new tab).

Requirements

  • TypeScript 5.0 or newer
  • The strict flag enabled in your tsconfig.json file
  • The exactOptionalPropertyTypes flag enabled in your tsconfig.json file
{
  // ...
  "compilerOptions": {
    // ...
    "strict": true,
    "exactOptionalPropertyTypes": true
  }
}

Platforms

Evolu runs on all evergreen desktop and mobile browsers.

  • Chrome 69+
  • Edge 79+
  • Safari 15.4+
  • Firefox 96+
  • Opera 56+

Evolu also runs on Electron. React Native soon.

ℹ️

Remember to set COOP and COEP HTTP Headers. Example (opens in a new tab)