-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinstall.html
More file actions
82 lines (82 loc) · 33.3 KB
/
Copy pathinstall.html
File metadata and controls
82 lines (82 loc) · 33.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<!doctype html><html lang=en dir=ltr class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-install" data-has-hydrated=false><head><meta charset=UTF-8><meta name=generator content="Docusaurus v3.10.1"><title data-rh=true>Installation | React Native Google Sign In</title><meta data-rh=true name=viewport content="width=device-width, initial-scale=1.0"/><meta data-rh=true name=twitter:card content=summary_large_image /><meta data-rh=true property=og:image content=https://react-native-google-signin.github.io/img/social-card.jpg /><meta data-rh=true name=twitter:image content=https://react-native-google-signin.github.io/img/social-card.jpg /><meta data-rh=true property=og:url content=https://react-native-google-signin.github.io/docs/install /><meta data-rh=true property=og:locale content=en /><meta data-rh=true name=docusaurus_locale content=en /><meta data-rh=true name=docsearch:language content=en /><meta data-rh=true name=docusaurus_version content=current /><meta data-rh=true name=docusaurus_tag content=docs-default-current /><meta data-rh=true name=docsearch:version content=current /><meta data-rh=true name=docsearch:docusaurus_tag content=docs-default-current /><meta data-rh=true property=og:title content="Installation | React Native Google Sign In"/><meta data-rh=true name=description content="Install `@react-native-google-signin/google-signin`. Covers paid (Universal Sign In) and free (Original) versions, requirements, and package manager setup."/><meta data-rh=true property=og:description content="Install `@react-native-google-signin/google-signin`. Covers paid (Universal Sign In) and free (Original) versions, requirements, and package manager setup."/><link data-rh=true rel=icon href=/img/favicon.ico /><link data-rh=true rel=canonical href=https://react-native-google-signin.github.io/docs/install /><link data-rh=true rel=alternate href=https://react-native-google-signin.github.io/docs/install hreflang=en /><link data-rh=true rel=alternate href=https://react-native-google-signin.github.io/docs/install hreflang=x-default /><script data-rh=true type=application/ld+json>{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","item":"https://react-native-google-signin.github.io/docs/install","name":"Installation","position":1}]}</script><link rel=stylesheet href=/assets/css/styles.c655e8c7.css /><script src=/assets/js/runtime~main.27c8b818.js defer></script><script src=/assets/js/main.1cb569e4.js defer></script></head><body><svg style="display: none;"><defs>
<symbol id=theme-svg-external-link viewBox="0 0 24 24"><path fill=currentColor d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
</defs></svg>
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme-32e")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||(window.matchMedia("(prefers-color-scheme: dark)").matches?"dark":"light")),document.documentElement.setAttribute("data-theme-choice",t||"system")}(),function(){try{for(var[t,e]of new URLSearchParams(window.location.search).entries())if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id=__docusaurus><link rel=preload as=image href=/img/logo.png /><div role=region aria-label="Skip to main content"><a class=skipToContent_fXgn href=#__docusaurus_skipToContent_fallback>Skip to main content</a></div><nav aria-label=Main class="theme-layout-navbar navbar navbar--fixed-top"><div class=navbar__inner><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded=false class="navbar__toggle clean-btn" type=button><svg width=30 height=30 viewBox="0 0 30 30" aria-hidden=true><path stroke=currentColor stroke-linecap=round stroke-miterlimit=10 stroke-width=2 d="M4 7h22M4 15h22M4 23h22"/></svg></button><a class=navbar__brand href=/><div class=navbar__logo><img src=/img/logo.png alt="My Site Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"/><img src=/img/logo.png alt="My Site Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"/></div><b class="navbar__title text--truncate">RN Google Sign In</b></a><a aria-current=page class="navbar__item navbar__link navbar__link--active" href=/docs/install>Guides</a><a class="navbar__item navbar__link" href=/docs/api>API</a><a class="navbar__item navbar__link" href=/examples>Example native & web app</a><div class="navbar__item dropdown dropdown--hoverable"><a href=# aria-haspopup=true aria-expanded=false role=button class=navbar__link>LLMs</a><ul class=dropdown__menu><li><a href=/llms.txt target=_blank rel="noopener noreferrer" class=dropdown__link>llms.txt<svg width=12 height=12 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a><li><a href=/llms-full.txt target=_blank rel="noopener noreferrer" class=dropdown__link>llms-full.txt<svg width=12 height=12 aria-label="(opens in new tab)" class=iconExternalLink_nPIU><use href=#theme-svg-external-link /></svg></a></ul></div></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a class="navbar__item navbar__link" href=/github-repo>GitHub</a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type=button disabled title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill=currentColor d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill=currentColor d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"/></svg><svg viewBox="0 0 24 24" width=24 height=24 aria-hidden=true class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill=currentColor d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"/></svg></button></div><div class=navbarSearchContainer_Bca1><div class=navbar__search><span aria-label="expand searchbar" role=button class=search-icon tabindex=0></span><input id=search_input_react type=search placeholder=Loading... aria-label=Search class="navbar__search-input search-bar" disabled/></div></div></div></div><div role=presentation class=navbar-sidebar__backdrop></div></nav><div id=__docusaurus_skipToContent_fallback class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class=docsWrapper_hBAB><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type=button></button><div class=docRoot_UBD9><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class=sidebarViewport_aRkj><div class=sidebar_njMd><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current=page href=/docs/install><span title=Installation class=linkLabel_WmDU>Installation</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/docs/category/setting-up><span title="Setting up" class=categoryLinkLabel_W154>Setting up</span></a><button aria-label="Expand sidebar category 'Setting up'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item sponsor-heart"><a class=menu__link href=/docs/one-tap><span title="Universal Google sign in" class=linkLabel_WmDU>Universal Google sign in</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/original><span title="Original Google sign in" class=linkLabel_WmDU>Original Google sign in</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item sponsor-heart"><a class=menu__link href=/docs/web-support><span title="Web support" class=linkLabel_WmDU>Web support</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item sponsor-heart"><a class=menu__link href=/docs/security><span title="Advanced security" class=linkLabel_WmDU>Advanced security</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/migrating><span title="Migration guides" class=linkLabel_WmDU>Migration guides</span></a><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class=menu__list-item-collapsible><a class="categoryLink_byQd menu__link menu__link--sublist" href=/docs/category/react-components><span title="React components" class=categoryLinkLabel_W154>React components</span></a><button aria-label="Expand sidebar category 'React components'" aria-expanded=false type=button class="clean-btn menu__caret"></button></div><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/testing><span title=Testing class=linkLabel_WmDU>Testing</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/errors><span title="Error handling" class=linkLabel_WmDU>Error handling</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/integration-notes><span title="Integration notes" class=linkLabel_WmDU>Integration notes</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/troubleshooting><span title=Troubleshooting class=linkLabel_WmDU>Troubleshooting</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item sponsor-heart"><a class=menu__link href=/docs/config-doctor><span title="Config doctor" class=linkLabel_WmDU>Config doctor</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/screenshots><span title=Screenshots class=linkLabel_WmDU>Screenshots</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/license><span title=License class=linkLabel_WmDU>License</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/other-libs><span title="Other libraries" class=linkLabel_WmDU>Other libraries</span></a><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class=menu__link href=/docs/api><span title="API reference" class=linkLabel_WmDU>API reference</span></a></ul></nav></div></div></aside><main class=docMainContainer_TBSr><div class="container padding-top--md padding-bottom--lg"><div class=row><div class="col docItemCol_VOVn"><div class=docItemContainer_Djhp><article><div class=breadcrumbsWrapper_xlkt><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label=Breadcrumbs><ul class=breadcrumbs><li class=breadcrumbs__item><a aria-label="Home page" class=breadcrumbs__link href=/><svg viewBox="0 0 24 24" class=breadcrumbHomeIcon_YNFT><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill=currentColor /></svg></a><li class="breadcrumbs__item breadcrumbs__item--active"><span class=breadcrumbs__link>Installation</span></ul></nav></div><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type=button class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Installation</h1></header>
<p>The recommended option is <a href=https://universal-sign-in.com target=_blank rel="noopener noreferrer" class="">Universal Sign In</a> (paid). A free legacy version is also available — see <a href=#public-version-free class="">below</a> for the differences. If you are an EAS customer, you may be able to access the paid version for free, <a href=https://forms.gle/tpP7TfUGW1CwgaEZ8 target=_blank rel="noopener noreferrer" class="">learn more</a>.</p>
<p>Why paid? According to the <a href=https://results.2024.stateofreactnative.com/en-US/opinions/#opinions_pain_points_multiple target=_blank rel="noopener noreferrer" class="">State of React Native Survey</a>, unmaintained packages are <strong>the #1 pain point</strong> of the React Native ecosystem. Your purchase enables the module to be rock-solid, and contributions to upstream SDKs such as <a href=https://github.com/openid/AppAuth-iOS/pull/788 target=_blank rel="noopener noreferrer" class="">1</a>, <a href=https://github.com/google/GoogleSignIn-iOS/pull/402 target=_blank rel="noopener noreferrer" class="">2</a>, <a href=https://github.com/googlesamples/google-services/issues/426 target=_blank rel="noopener noreferrer" class="">3</a>, <a href=https://github.com/google/GoogleSignIn-iOS/issues/457 target=_blank rel="noopener noreferrer" class="">4</a>, <a href=https://issuetracker.google.com/issues/424210681 target=_blank rel="noopener noreferrer" class="">5</a>, <a href=https://issuetracker.google.com/issues/474817166 target=_blank rel="noopener noreferrer" class="">6</a>.</p>
<section class=creem-payment aria-labelledby=creem-payment-title><div><p class=creem-payment__eyebrow>Universal Sign In license<h2 id=creem-payment-title>Ready to install Universal Sign In?</h2><p>Buy a license, then use the private npm registry setup below to add the package to your app.</div><a class="button button--primary creem-payment__button" href=https://www.creem.io/payment/prod_2zElFBVDXGigzZTiK4MvYX rel=noreferrer target=_blank>Buy license</a></section>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=premium>Universal Sign In (premium)<a href=#premium class=hash-link aria-label="Direct link to Universal Sign In (premium)" title="Direct link to Universal Sign In (premium)" translate=no></a></h3>
<p>⭐️ <strong>Key Features</strong>:</p>
<ul>
<li class="">
<p><strong>Cross-Platform</strong>: Unified APIs which work on <strong>Android</strong>, <strong>iOS</strong>, <strong>Web</strong>, and <strong>macOS</strong>.</p>
<ul>
<li class="">Android: Built with <a href=https://developers.google.com/identity/android-credential-manager target=_blank rel="noopener noreferrer" class="">Credential Manager library</a></li>
<li class="">Web: Uses <a href=https://developers.google.com/identity/gsi/web/guides/features target=_blank rel="noopener noreferrer" class="">Sign In with Google for Web</a></li>
<li class="">iOS & macOS: Powered by the <a href=https://developers.google.com/identity/sign-in/ios/start target=_blank rel="noopener noreferrer" class="">Google Sign-In SDK</a></li>
</ul>
</li>
<li class="">
<p><strong>Licensed:</strong> see <a href=https://universal-sign-in.com/#pricing target=_blank rel="noopener noreferrer" class="">pricing</a> and <a href=https://universal-sign-in.com/license target=_blank rel="noopener noreferrer" class="">license</a>.</p>
</li>
<li class="">
<p><strong>Trusted</strong>: 1 mil+ npm downloads.</p>
</li>
<li class="">
<p><strong>Faster</strong>: Reduce sign-up and sign-in times on Android, according to <a href=https://developer.android.com/identity/sign-in/legacy-gsi-migration#authentication target=_blank rel="noopener noreferrer" class="">Google</a>.</p>
</li>
<li class="">
<p><strong>See the UI</strong>: <a class="" href=/docs/screenshots>screenshots</a> of the features.</p>
</li>
<li class="">
<p><strong>Widely compatible & stable:</strong> Both old and <a href=https://reactnative.dev/architecture/landing-page target=_blank rel="noopener noreferrer" class="">new architecture</a> of React Native are supported. See version <a href=#requirements class="">compatibility table</a> below.</p>
</li>
</ul>
<p>🔧 <strong>Easier setup</strong>:</p>
<ul>
<li class="">Android <a class="" href=/docs/config-doctor>Config Doctor</a> to diagnose configuration errors before they cost you hours.</li>
<li class="">Automatic detection of <a class="" href=/docs/one-tap#automatic-config>configuration parameters</a> for faster integration.</li>
</ul>
<p>🛡️ <strong>Advanced <a class="" href=/docs/security>security features</a></strong></p>
<p>📱 <strong>An example app</strong> — to showcase all features on native and web</p>
<h3 class="anchor anchorTargetStickyNavbar_Vzrq" id=public-version-free>Public version (free)<a href=#public-version-free class=hash-link aria-label="Direct link to Public version (free)" title="Direct link to Public version (free)" translate=no></a></h3>
<p>Available on the public npm registry, this version:</p>
<ul>
<li class="">Built on the <a href=https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating target=_blank rel="noopener noreferrer" class="">deprecated legacy Android Google Sign-In SDK</a> — Google has since moved away from it, and may remove it from Play Services at their discretion. The free package will continue to use a version where this SDK is present.</li>
<li class="">Has platform support limited to Android and iOS.</li>
<li class="">Contains none of the extra features listed above.</li>
</ul>
<blockquote>
<p>To migrate from the public version to the premium one, follow the <a class="" href=/docs/migrating#migrating-from-original-to-universal-sign-in>migration guide</a>.</p>
</blockquote>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=package-manager-setup>Accessing the private npm package<a href=#package-manager-setup class=hash-link aria-label="Direct link to Accessing the private npm package" title="Direct link to Accessing the private npm package" translate=no></a></h2>
<p>The private npm package is like any other, but it's hosted on the <a href=https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry target=_blank rel="noopener noreferrer" class="">GitHub npm packages registry</a>, not the public npm registry. Therefore, a small bit of setup is needed:</p>
<ol>
<li class="">
<p>Set up access via the <a href=https://universal-sign-in.com/auth/login target=_blank rel="noopener noreferrer" class="">subscription dashboard</a>.</p>
</li>
<li class="">
<p><a href="https://github.com/settings/tokens/new?description=react-native-google-sign-in&scopes=read:packages" target=_blank rel="noopener noreferrer" class="">Obtain here</a> a Personal Access Token with <code>packages:read</code> permission and set expiration to "No expiration".</p>
</li>
<li class="">
<p>Set up your package manager to fetch the package from the GitHub packages registry. In this example, we're using an <code>NPM_TOKEN_GOOGLE_SIGN_IN</code> environment variable.</p>
</li>
</ol>
<!-- -->
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_LNqP tabs__item--active">yarn v3+<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_LNqP">npm / yarn v1<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_LNqP">pnpm<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_LNqP">bun<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_LNqP">CI environments (GH Actions...)</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Ymn6><p>create a <code>.yarnrc.yml</code> file in your project root with the following content:<div class="language-yml codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockTitle_OeMC>.yarnrc.yml</div><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-yml codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token key atrule" style=color:#00a4db>npmScopes</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>react-native-google-signin</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"></span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>npmRegistryServer</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> https</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain">//npm.pkg.github.com</span><br/></div><div class=token-line style=color:#393A34><span class="token plain"> </span><span class="token key atrule" style=color:#00a4db>npmAuthToken</span><span class="token punctuation" style=color:#393A34>:</span><span class="token plain"> </span><span class="token string" style=color:#e3116c>'${NPM_TOKEN_GOOGLE_SIGN_IN}'</span><br/></div></code></pre></div></div></div><div role=tabpanel class=tabItem_Ymn6 hidden><p>create a <code>.npmrc</code> file in your project root with the following content:<div class="language-txt codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockTitle_OeMC>.npmrc</div><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-txt codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">//npm.pkg.github.com/:_authToken=${NPM_TOKEN_GOOGLE_SIGN_IN}</span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">@react-native-google-signin:registry=https://npm.pkg.github.com/</span><br/></div></code></pre></div></div></div><div role=tabpanel class=tabItem_Ymn6 hidden><p>create a <code>.npmrc</code> file in your project root with the following content (pnpm respects <code>.npmrc</code>):<div class="language-txt codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockTitle_OeMC>.npmrc</div><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-txt codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">//npm.pkg.github.com/:_authToken=${NPM_TOKEN_GOOGLE_SIGN_IN}</span><br/></div><div class=token-line style=color:#393A34><span class="token plain" style=display:inline-block></span><br/></div><div class=token-line style=color:#393A34><span class="token plain">@react-native-google-signin:registry=https://npm.pkg.github.com/</span><br/></div></code></pre></div></div></div><div role=tabpanel class=tabItem_Ymn6 hidden><p>create a <code>bunfig.toml</code> file in your project root with the following content:<div class="language-toml codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockTitle_OeMC>bunfig.toml</div><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-toml codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">[install.scopes]</span><br/></div><div class=token-line style=color:#393A34><span class="token plain">"@react-native-google-signin" = { url = "https://npm.pkg.github.com/", token = "$NPM_TOKEN_GOOGLE_SIGN_IN" }</span><br/></div></code></pre></div></div><p>Alternatively, <a href=https://bun.sh/docs/pm/npmrc#configure-options-for-a-specific-registry target=_blank rel="noopener noreferrer" class="">bun also reads <code>.npmrc</code> files</a>, so the npm setup above works too.</div><div role=tabpanel class=tabItem_Ymn6 hidden><p>CI environment setup is similar to the local one: you also need a <code>.npmrc</code> (or similar) file. Follow <a href=https://gist.github.com/nandorojo/46b3e46de12177b9ad7e4d454310de21#file-private-npm-in-gh-actions-md target=_blank rel="noopener noreferrer" class="">this GitHub Actions example</a> - other CI providers require very similar steps.</div></div></div>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=installing>Installing<a href=#installing class=hash-link aria-label="Direct link to Installing" title="Direct link to Installing" translate=no></a></h2>
<div class="theme-tabs-container tabs-container tabList__CuJ"><ul role=tablist aria-orientation=horizontal class=tabs><li role=tab tabindex=0 aria-selected=true class="tabs__item tabItem_LNqP tabs__item--active">yarn<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_LNqP">npm<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_LNqP">pnpm<li role=tab tabindex=-1 aria-selected=false class="tabs__item tabItem_LNqP">bun</ul><div class=margin-top--md><div role=tabpanel class=tabItem_Ymn6><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token function" style=color:#d73a49>yarn</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>add</span><span class="token plain"> @react-native-google-signin/google-signin@latest</span><br/></div></code></pre></div></div></div><div role=tabpanel class=tabItem_Ymn6 hidden><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token function" style=color:#d73a49>npm</span><span class="token plain"> i @react-native-google-signin/google-signin@latest</span><br/></div></code></pre></div></div></div><div role=tabpanel class=tabItem_Ymn6 hidden><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token function" style=color:#d73a49>pnpm</span><span class="token plain"> </span><span class="token function" style=color:#d73a49>add</span><span class="token plain"> @react-native-google-signin/google-signin@latest</span><br/></div></code></pre></div></div></div><div role=tabpanel class=tabItem_Ymn6 hidden><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style=--prism-color:#393A34;--prism-background-color:#f6f8fa><div class=codeBlockContent_QJqH><pre tabindex=0 class="prism-code language-bash codeBlock_bY9V thin-scrollbar" style=color:#393A34;background-color:#f6f8fa><code class=codeBlockLines_e6Vv><div class=token-line style=color:#393A34><span class="token plain">bun </span><span class="token function" style=color:#d73a49>add</span><span class="token plain"> @react-native-google-signin/google-signin@latest</span><br/></div></code></pre></div></div></div></div></div>
<p>After installing: if you're using the Universal version, open the lockfile (<code>yarn.lock</code> / <code>package-lock.json</code>...) and verify that the package is fetched from the GitHub registry (the entry must point to <code>npm.pkg.github.com</code>, not <code>registry.npmjs.org</code>). If it does not, it means the package manager is not configured correctly — try uninstalling and reinstalling the package.</p>
<p>There are several guides to follow now:</p>
<ul>
<li class=""><a class="" href=/docs/setting-up/expo>Expo guide</a> for native mobile apps built with Expo</li>
<li class=""><a class="" href=/docs/setting-up/web>Web guide</a> if you want to use the package on web</li>
<li class="">If you're not using Expo but plain React Native, follow <a class="" href=/docs/setting-up/android>Android guide</a> and <a class="" href=/docs/setting-up/ios>iOS guide</a></li>
</ul>
<h2 class="anchor anchorTargetStickyNavbar_Vzrq" id=requirements>Requirements<a href=#requirements class=hash-link aria-label="Direct link to Requirements" title="Direct link to Requirements" translate=no></a></h2>
<p>For latest version of Universal Sign In, <code>compileSdkVersion</code> must be <!-- -->>=<!-- --> 35 and <code>kotlinVersion</code> must be <!-- -->>=<!-- --> 2.0.21 in your Android project. If you use Expo SDK 53 or newer, these requirements are already met. Use <a href=https://docs.expo.dev/versions/latest/sdk/build-properties/#example-appjson-with-config-plugin target=_blank rel="noopener noreferrer" class=""><code>expo-build-properties</code></a> to specify these values on Expo SDK <!-- --><=<!-- --> 52.</p>
<p>The latest version of the Universal Sign In package supports (use older versions of the package if you run older React Native / Expo):</p>
<table><thead><tr><th><th>supported range<tbody><tr><td>expo<td>52.0.40 - 56<tr><td>react-native<td>0.76.0 - 0.86</table>
<blockquote>
<p>We recommend <a href=https://expo.dev target=_blank rel="noopener noreferrer" class="">Expo</a> and <a href=https://expo.dev/eas target=_blank rel="noopener noreferrer" class="">EAS</a> for building and deploying your React Native app. Expo offers the best developer experience and is well-supported by this library.</p>
</blockquote></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href=https://github.com/react-native-google-signin/docs/edit/main/docs/install.mdx target=_blank rel="noopener noreferrer" class=theme-edit-this-page><svg fill=currentColor height=20 width=20 viewBox="0 0 40 40" class=iconEdit_Z9Sw aria-hidden=true><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"/></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--next" href=/docs/category/setting-up><div class=pagination-nav__sublabel>Next</div><div class=pagination-nav__label>Setting up</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href=#premium class="table-of-contents__link toc-highlight">Universal Sign In (premium)</a><li><a href=#public-version-free class="table-of-contents__link toc-highlight">Public version (free)</a><li><a href=#package-manager-setup class="table-of-contents__link toc-highlight">Accessing the private npm package</a><li><a href=#installing class="table-of-contents__link toc-highlight">Installing</a><li><a href=#requirements class="table-of-contents__link toc-highlight">Requirements</a></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="footer__bottom text--center"><div class=footer__copyright>Copyright © 2026 <a href=https://universal-sign-in.com/>universal-sign-in.com</a></div></div></div></footer></div></body>