11# Evolu
22
3- Evolu is TypeScript library and local-first platform.
3+ Evolu is a TypeScript library and local-first platform.
44
55## Documentation
66
@@ -20,7 +20,7 @@ To chat with other community members, you can join the [Evolu Discord](https://d
2020
2121We provide a free relay ` free.evoluhq.com ` for testing and personal usage.
2222
23- The Evolu Relay source along with the Docker files can be in the [ /apps/relay] ( /apps/relay ) directory.
23+ The Evolu Relay source and Docker files are in the [ /apps/relay] ( /apps/relay ) directory.
2424
2525Alternatively, a pre-built image ` evoluhq/relay:latest ` is hosted on [ Docker Hub] ( https://hub.docker.com/r/evoluhq/relay ) .
2626
@@ -36,39 +36,37 @@ Install dependencies:
3636pnpm install
3737```
3838
39- Build monorepo:
39+ Build scripts
4040
41- ```
42- pnpm build
43- pnpm build:web
44- ```
41+ - ` pnpm build ` - Build packages
42+ - ` pnpm build:web ` - Build web
43+ - ` pnpm examples:build ` - Build all examples
4544
46- Start dev:
45+ Start dev
4746
48- ```
49- # web
50- pnpm dev
47+ > ** Warning** : Run ` pnpm build ` before running dev. Packages must be built first.
5148
52- # expo (pnpm dev must be running too)
53- pnpm ios
54- pnpm android
55- ```
49+ - ` pnpm dev ` - Dev server for web
50+ - ` pnpm ios ` - Run iOS example (requires ` pnpm dev ` running)
51+ - ` pnpm android ` - Run Android example (requires ` pnpm dev ` running)
52+ - ` pnpm examples:react-nextjs:dev ` - Dev server for React Next.js example
53+ - ` pnpm examples:react-vite-pwa:dev ` - Dev server for React Vite PWA example
54+ - ` pnpm examples:svelte-vite-pwa:dev ` - Dev server for Svelte Vite PWA example
55+ - ` pnpm examples:vue-vite-pwa:dev ` - Dev server for Vue Vite PWA example
5656
57- Linting:
57+ Linting
5858
59- ```
60- pnpm lint
61- pnpm lint-monorepo
62- ```
59+ - ` pnpm lint ` - Lint code
60+ - ` pnpm lint-monorepo ` - Lint monorepo structure
6361
64- Tests
62+ Testing
6563
66- ```
67- pnpm test
68- ```
64+ - ` pnpm test ` - Run tests
6965
70- Describe changes for release log:
66+ Release
7167
72- ```
73- pnpm changeset
74- ```
68+ - ` pnpm changeset ` - Describe changes for release log
69+
70+ Verify
71+
72+ - ` pnpm verify ` - Run all checks (build, lint, test) before commit
0 commit comments