From 86078c6d6efe032fd86aeb094af37f13c393aa3a Mon Sep 17 00:00:00 2001 From: Bereket Engida Date: Sun, 3 Nov 2024 02:15:07 +0300 Subject: [PATCH] chore: update expo example readme --- examples/expo-example/.env.example | 5 +++ examples/expo-example/README.md | 57 ++++++------------------------ 2 files changed, 16 insertions(+), 46 deletions(-) create mode 100644 examples/expo-example/.env.example diff --git a/examples/expo-example/.env.example b/examples/expo-example/.env.example new file mode 100644 index 0000000000..7743124047 --- /dev/null +++ b/examples/expo-example/.env.example @@ -0,0 +1,5 @@ +GITHUB_CLIENT_ID= +GITHUB_CLIENT_SECRET= +GOOGLE_CLIENT_ID= +GOOGLE_CLIENT_SECRET= +BETTER_AUTH_SECRET= \ No newline at end of file diff --git a/examples/expo-example/README.md b/examples/expo-example/README.md index cd4feb8a3c..0f8ecce1f1 100644 --- a/examples/expo-example/README.md +++ b/examples/expo-example/README.md @@ -1,50 +1,15 @@ -# Welcome to your Expo app 👋 + # Better Auth Expo Example -This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app). + This is an example of how to use Better Auth with Expo. It uses Expo's new API Router to host the auth server. -## Get started + ## How to run -1. Install dependencies + 1. Clone the code sandbox (or the repo) and open it in your code editor + 2. Move and Provide environment variable + 3. Run the following commands + ```bash + pnpm install + pnpm start + ```s - ```bash - npm install - ``` - -2. Start the app - - ```bash - npx expo start - ``` - -In the output, you'll find options to open the app in a - -- [development build](https://docs.expo.dev/develop/development-builds/introduction/) -- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/) -- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/) -- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo - -You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction). - -## Get a fresh project - -When you're ready, run: - -```bash -npm run reset-project -``` - -This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing. - -## Learn more - -To learn more about developing your project with Expo, look at the following resources: - -- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides). -- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web. - -## Join the community - -Join our community of developers creating universal apps. - -- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute. -- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions. + Checkout the [expo guide](https://www.better-auth.com/docs/integrations/expo) to learn more. \ No newline at end of file