Evolu

Evolu is a TypeScript library and local-first platform.

Documentation

Please visit evolu.dev.

Community

The Evolu community is on GitHub Discussions, where you can ask questions and voice ideas.

To chat with other community members, you can join the Evolu Discord.

Hosting Evolu Relay

We provide a free relay free.evoluhq.com for testing and personal usage.

The Evolu Relay source and Docker files are in the /apps/relay directory.

Alternatively, a pre-built image evoluhq/relay:latest is hosted on Docker Hub.

For more information, reference the Evolu Relay documentation.

Developing

Evolu monorepo uses pnpm.

Install dependencies:

pnpm install

Build scripts

• pnpm build - Build packages
• pnpm build:web - Build web
• pnpm examples:build - Build all examples

Start dev

Warning: Run pnpm build before running dev. Packages must be built first.

• pnpm dev - Dev server for web
• pnpm ios - Run iOS example (requires pnpm dev running)
• pnpm android - Run Android example (requires pnpm dev running)
• pnpm examples:react-nextjs:dev - Dev server for React Next.js example
• pnpm examples:react-vite-pwa:dev - Dev server for React Vite PWA example
• pnpm examples:svelte-vite-pwa:dev - Dev server for Svelte Vite PWA example
• pnpm examples:vue-vite-pwa:dev - Dev server for Vue Vite PWA example

Linting

• pnpm lint - Lint code
• pnpm lint-monorepo - Lint monorepo structure

Testing

• pnpm test - Run tests

Release

• pnpm changeset - Describe changes for release log

Verify

• pnpm verify - Run all checks (build, lint, test) before commit