https://github.com/react-appwrite/react-appwrite
⚛️ Gorgeous library for integrating React with Appwrite.
https://github.com/react-appwrite/react-appwrite
appwrite firebase hooks react typescript
Last synced: 7 months ago
JSON representation
⚛️ Gorgeous library for integrating React with Appwrite.
- Host: GitHub
- URL: https://github.com/react-appwrite/react-appwrite
- Owner: react-appwrite
- License: mit
- Created: 2021-12-12T17:07:37.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-10T10:39:16.000Z (over 2 years ago)
- Last Synced: 2025-03-28T20:09:28.593Z (7 months ago)
- Topics: appwrite, firebase, hooks, react, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/react-appwrite
- Size: 724 KB
- Stars: 38
- Watchers: 2
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
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](/src/account)
- [Avatars](/src/avatars)
- [Databases](/src/databases)
- [Functions](/src/functions)
- [Locale](/src/locale)
- [Next.js](/src/next)
- [Storage](/src/storage)
- [Teams](/src/teams)
### Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)
### Installation
```
npm i react-appwrite appwrite
```
### Configuration
```tsx
import { Client } from 'appwrite'
import { AppwriteProvider } from 'react-appwrite'
const appwrite = new Client()
.setEndpoint('https://my-appwrite-url.com')
.setProject('myAppwriteProjectId')
function App() {
return (
{
// ...
}
)
}
```
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/react-appwrite/react-appwrite/discussions/1) 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](/LICENSE)
