diff --git a/README.md b/README.md index cd4feb8..1763cf2 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,78 @@ -# Welcome to your Expo app 👋 +

+ + + + Clerk Logo for light background + + +
+

+
+

+ Clerk and Expo Quickstart +

+ + Downloads + + + Discord + + + Twitter + +
+
+ Clerk Hero Image +
+ +## Introduction + +Clerk is a developer-first authentication and user management solution. It provides pre-built React components and hooks for sign-in, sign-up, user profile, and organization management. Clerk is designed to be easy to use and customize, and can be dropped into any React or Next.js application. + +After following the quickstart you'll have learned how to: + +- Install `@clerk/clerk-expo` +- Setup your environment key +- Wrap your Expo app in `` and supply your `tokenCache` +- Conditionally show content based on your auth state +- Build your sign-in and sign-up pages + +## Running the template -This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app). +```bash +git clone https://github.com/clerk/clerk-expo-quickstart +``` -## Get started +To run the example locally, you'll need to make sure you have XCode installed and configured properly, then: -1. Install dependencies +1. Sign up for a Clerk account at [https://clerk.com](https://dashboard.clerk.com/sign-up?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-expo-quickstart). - ```bash - npm install - ``` +2. Go to the [Clerk dashboard](https://dashboard.clerk.com?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-expo-quickstart) and create an application. -2. Start the app +3. Set the required Clerk environment variable as shown in [the example `env` file](./.env.example). - ```bash - npx expo start - ``` +4. `npm install` the required dependencies. -In the output, you'll find options to open the app in a +5. `npm run start` to launch the development server. -- [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 +## Learn more -You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction). +To learn more about Clerk and Expo, check out the following resources: -## Get a fresh project +- [Quickstart: Get started with Expo and Clerk](https://clerk.com/docs/quickstarts/expo?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-expo-quickstart) -When you're ready, run: +- [Clerk Documentation](https://clerk.com/docs/references/expo/overview?utm_source=DevRel&utm_medium=docs&utm_campaign=templates&utm_content=10-24-2023&utm_term=clerk-expo-quickstart) -```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. +- [Expo Documentation](https://docs.expo.dev/) -## Learn more +## Found an issue? -To learn more about developing your project with Expo, look at the following resources: +If you have found an issue with the quickstart or have any questions, please visit our [Discord](https://clerk.com/discord) or reach out to our [Support team](mailto:support@clerk.dev). -- [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. +If it's a quick fix, such as a misspelled word or a broken link, go ahead and create a [pull request](https://github.com/clerk/clerk-expo-quickstart/pulls) with the solution. :rocket: -## Join the community +## Connect with us -Join our community of developers creating universal apps. +You can discuss ideas, ask questions, and meet others from the community in our [Discord](https://clerk.com/discord). -- [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. +If you prefer, you can also find support through our [Twitter](https://twitter.com/ClerkDev), or you can [email](mailto:support@clerk.dev) us! diff --git a/assets/images/dark-logo.png b/assets/images/dark-logo.png new file mode 100644 index 0000000..e2635de Binary files /dev/null and b/assets/images/dark-logo.png differ diff --git a/assets/images/hero.png b/assets/images/hero.png new file mode 100644 index 0000000..af640e1 Binary files /dev/null and b/assets/images/hero.png differ diff --git a/assets/images/light-logo.png b/assets/images/light-logo.png new file mode 100644 index 0000000..2941bed Binary files /dev/null and b/assets/images/light-logo.png differ