beginner
10 min

Start with React Native

Learn how to setup your first React Native project powered by Appwrite. The React Native SDK is still in beta. Proceed with caution if you plan to use this SDK in production.

React for web

Looking to start with React for web? Follow the React quickstart and React tutorial flows.

Create React Native project

Create a React Native project using npx.

Shell

npx create-expo-app my-app
cd my-app

Create project

Head to the Appwrite Console.

If this is your first time using Appwrite, create an account and create your first project.

Then, under Add a platform, add a Android app or a Apple app.

You can skip optional steps.

Install Appwrite

Install the Appwrite SDK for React Native and required dependencies.

Shell

npx expo install react-native-appwrite react-native-url-polyfill

Implement Appwrite

Find your project's ID in the Settings page.

Open App.js and add the following code to it, replace <YOUR_PROJECT_ID> with your project ID and <YOUR_PLATFORM> with your application id or package name.

This imports and initializes Appwrite and defines some basic authentication methods.

TypeScript

import { StatusBar } from 'expo-status-bar';
import { StyleSheet, Text, View, TextInput, TouchableOpacity } from 'react-native';
import { Client, Account, ID } from 'react-native-appwrite';
import React, { useState } from 'react';

let client;
let account;

client = new Client();
client
  .setEndpoint('https://cloud.appwrite.io/v1')
  .setProject('sisyphus')
  .setPlatform('com.example.my-app');

account = new Account(client);
export default function App() {
  const [loggedInUser, setLoggedInUser] = useState(null);
  const [email, setEmail] = useState('');
  const [password, setPassword] = useState('');
  const [name, setName] = useState('');

  async function login(email, password) {
    await account.createEmailSession(email, password);
    setLoggedInUser(await account.get());
  }

  async function register(email, password, name) {
    await account.create(ID.unique(), email, password, name);
    await login(email, password);
    setLoggedInUser(await account.get());
  }
  return (
    // ... Implement your UI here
  );
}

const styles = StyleSheet.create({
    // ... define some tyles
});

Create a login form

With Client and Account service initialized, you can now use them to make your first requests to Appwrite.

Add the following components to your App.js file to create a simple login form.

TypeScript

<View style={styles.root}>
    <Text>
    {loggedInUser ? `Logged in as ${loggedInUser.name}` : 'Not logged in'}
    </Text>
    <View>
    <TextInput
        style={styles.input}
        placeholder="Email"
        value={email}
        onChangeText={(text) => setEmail(text)}
    />
    <TextInput
        style={styles.input}
        placeholder="Password"
        value={password}
        onChangeText={(text) => setPassword(text)}
        secureTextEntry
    />
    <TextInput
        style={styles.input}
        placeholder="Name"
        value={name}
        onChangeText={(text) => setName(text)}
    />

    <TouchableOpacity
        style={styles.button}
        onPress={() => login(email, password)}
    >
        <Text>Login</Text>
    </TouchableOpacity>

    <TouchableOpacity
        style={styles.button}
        onPress={()=> register(email, password, name)}
    >
        <Text>Register</Text>
    </TouchableOpacity>

    <TouchableOpacity
        style={styles.button}
        onPress={async () => {
        await account.deleteSession('current');
        setLoggedInUser(null);
        }}
    >
        <Text>Logout</Text>
    </TouchableOpacity>
    </View>
</View>

You can also add some simple styling to your app by adding the following styles to your App.js file.

TypeScript

const styles = StyleSheet.create({
  root: {
    marginTop: 40, 
    marginBottom: 40
  },
  input: {
    height: 40,
    borderColor: 'gray',
    borderWidth: 1,
    marginBottom: 10,
    paddingHorizontal: 10,
  },
  button: {
    backgroundColor: 'gray',
    padding: 10,
    marginBottom: 10,
    alignItems: 'center',
  },
});

All set

Run your project with npx expo start.

Explore the React Native playground

Was this page helpful?

Update on GitHub

React for web

Recommended