diff --git a/apps/web/pages/docs/getting-started.mdx b/apps/web/pages/docs/getting-started.mdx deleted file mode 100644 index 9c206ecfc..000000000 --- a/apps/web/pages/docs/getting-started.mdx +++ /dev/null @@ -1,49 +0,0 @@ -# Getting Started - -## Installation - -```sh -npm install @evolu/react -# or -npm install @evolu/react-native -``` - -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](https://pnpm.io). - -### 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 and React Native. - -import { Callout } from "nextra-theme-docs"; - - - Remember to set COOP and COEP HTTP Headers. - [Example](https://github.com/evoluhq/evolu/blob/main/examples/nextjs/next.config.js) - diff --git a/apps/web/pages/docs/getting-started/instalation.mdx b/apps/web/pages/docs/getting-started/instalation.mdx new file mode 100644 index 000000000..06c8e94c9 --- /dev/null +++ b/apps/web/pages/docs/getting-started/instalation.mdx @@ -0,0 +1,53 @@ +import { Callout } from "nextra-theme-docs"; +import { Steps } from "nextra/components"; +import { Tabs } from "nextra/components"; + +# Installation + +Supported Platforms: + +- All desktop and mobile browsers +- Electron +- React Native + +Requirements: + +- TypeScript 5.0 or newer +- The `strict` flag enabled in your `tsconfig.json` file + + +### Choose Framework + +Evolu is tested with: [Next.js](https://nextjs.org), [Vite](https://vitejs.dev), +[Electron](https://www.electronjs.org), [Expo](https://expo.dev) + +### Install Evolu + + + + + ```bash filename="Terminal" + npm install @evolu/react + ``` + + + + + ```bash filename="Terminal" + npm install @evolu/react-native + ``` + + + + +### Add Settings + +Check [examples](https://github.com/evoluhq/evolu/tree/main/examples) +for additional settings. + + + For the web, remember to set COOP and COEP HTTP Headers. + [Example](https://github.com/evoluhq/evolu/blob/main/examples/nextjs/next.config.js) + + +