
# Getting Started

### Installation

```bash
npm i react-appwrite appwrite
```

### Configuration

```typescript
import { Client } from "appwrite";
import { AppwriteProvider } from "react-appwrite";

const appwrite = new Client()
  .setEndpoint("https://my-appwrite-url.com")
  .setProject("myAppwriteProjectId");

function App() {
  return (
    <AppwriteProvider client={appwrite}>
      {
        // ...
      }
    </AppwriteProvider>
  );
}
```

This library is powered by [react-query](https://tanstack.com/query/v4/docs/react/reference/useQuery).
Hooks follow this format.

```typescript
const { data, isLoading } = useHook(...)
```

### Contributing

> **Note**
> We're looking for maintainers! [Leave a comment](https://github.com/sanny-io/react-appwrite/discussions/1) if you'd like to help out.

Follow these steps to get started with local development.

1. Clone the repository.

```bash
git clone https://github.com/sanny-io/react-appwrite.git
cd react-appwrite
```

2. Install dependencies.

```
npm i
```

3. Execute the development script.

```bash
npm run dev
```

Follow these extra steps if you'd like to test with the provided example
project.

1. In another terminal, navigate to the `example` directory.

```bash
cd example
```

2. Create your `.env` file.

```bash
cp .env.example .env
```

3. Replace the environment variables in `.env` with your own.

4. Install dependencies.

```bash
npm i
```

5. Execute development script.

```bash
npm run dev
```

### License

[MIT](/LICENSE)
