react-appwrite

Gorgeous library for integrating React with Appwrite.

Features

✅ Realtime updates for everything

✅ Next.js middleware support

✅ React Server Components (RSC) support

✅ Optimized for performance with minimal re-renders

✅ Incredibly simple API

✅ Fully typed, written 100% in TypeScript

✅ Eventual feature parity with the Appwrite SDK

Supported Services

This library is a work in progress. The intent is to eventually reach 100% feature parity with Appwrite.

• Account
• Avatars
• Databases
• Functions
• Locale
• Next.js
• Storage
• Teams

Table of Contents

• Installation
• Configuration
• Contributing
• License

Installation

npm i react-appwrite appwrite

Configuration

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. Hooks follow this format.

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

Contributing

Note We're looking for maintainers! Leave a comment if you'd like to help out.

Follow these steps to get started with local development.

1. Clone the repository.

git clone https://github.com/react-appwrite/react-appwrite.git
cd react-appwrite

2. Install dependencies.

npm i

3. Execute the development script.

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.

cd example

2. Create your .env file.

cp .env.example .env

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

4. Install dependencies.

npm i

5. Execute development script.

npm run dev

License

MIT