Skip to content

Commit

Permalink
Create instalation.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
steida committed Nov 30, 2023
1 parent 304c957 commit b45b269
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 49 deletions.
49 changes: 0 additions & 49 deletions apps/web/pages/docs/getting-started.mdx

This file was deleted.

53 changes: 53 additions & 0 deletions apps/web/pages/docs/getting-started/instalation.mdx
Original file line number Diff line number Diff line change
@@ -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

<Steps>
### 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

<Tabs items={["React", "React Native"]}>
<Tabs.Tab>

```bash filename="Terminal"
npm install @evolu/react
```

</Tabs.Tab>
<Tabs.Tab>

```bash filename="Terminal"
npm install @evolu/react-native
```

</Tabs.Tab>
</Tabs>

### Add Settings

Check [examples](https://github.com/evoluhq/evolu/tree/main/examples)
for additional settings.

<Callout type="warning" emoji="‼️">
For the web, remember to set COOP and COEP HTTP Headers.
[Example](https://github.com/evoluhq/evolu/blob/main/examples/nextjs/next.config.js)
</Callout>

</Steps>

1 comment on commit b45b269

@vercel
Copy link

@vercel vercel bot commented on b45b269 Nov 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

evolu – ./

evolu-git-main-evolu.vercel.app
evolu-evolu.vercel.app
www.evolu.dev
evolu.vercel.app
evolu.dev

Please sign in to comment.