@daimo/pay 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (192) hide show
  1. package/LICENSE +26 -0
  2. package/README.md +77 -0
  3. package/build/index.es.js +12076 -0
  4. package/build/index.es.js.map +1 -0
  5. package/build/packages/pay-api/src/db/codegen/dbPay.d.ts +69 -0
  6. package/build/packages/pay-api/src/db/db.d.ts +68 -0
  7. package/build/packages/pay-api/src/db/migrations/0.d.ts +2 -0
  8. package/build/packages/pay-api/src/db/migrations/1.d.ts +2 -0
  9. package/build/packages/pay-api/src/db/migrations/2.d.ts +2 -0
  10. package/build/packages/pay-api/src/db/migrations/3.d.ts +2 -0
  11. package/build/packages/pay-api/src/env.d.ts +10 -0
  12. package/build/packages/pay-api/src/index.d.ts +2 -0
  13. package/build/packages/pay-api/src/server/binanceClient.d.ts +14 -0
  14. package/build/packages/pay-api/src/server/constants.d.ts +3 -0
  15. package/build/packages/pay-api/src/server/dfsQuoter.d.ts +21 -0
  16. package/build/packages/pay-api/src/server/externalPaymentOptions.d.ts +21 -0
  17. package/build/packages/pay-api/src/server/orderProcessor.d.ts +48 -0
  18. package/build/packages/pay-api/src/server/orgManager.d.ts +22 -0
  19. package/build/packages/pay-api/src/server/router.d.ts +252 -0
  20. package/build/packages/pay-api/src/server/swap.d.ts +24 -0
  21. package/build/packages/pay-api/src/server/tokenBalances.d.ts +12 -0
  22. package/build/packages/pay-api/src/server/tokenRegistry.d.ts +16 -0
  23. package/build/packages/pay-api/src/server/viemChainClient.d.ts +252 -0
  24. package/build/packages/pay-api/src/server/viemClient.d.ts +19 -0
  25. package/build/packages/pay-api/src/trpc.d.ts +129 -0
  26. package/build/packages/pay-api/src/utils/clippy.d.ts +2 -0
  27. package/build/packages/pay-api/src/utils/request.d.ts +19 -0
  28. package/build/packages/paykit/packages/connectkit/src/assets/ScanIconWithLogos.d.ts +5 -0
  29. package/build/packages/paykit/packages/connectkit/src/assets/browsers.d.ts +10 -0
  30. package/build/packages/paykit/packages/connectkit/src/assets/chains.d.ts +67 -0
  31. package/build/packages/paykit/packages/connectkit/src/assets/coins.d.ts +2 -0
  32. package/build/packages/paykit/packages/connectkit/src/assets/icons.d.ts +33 -0
  33. package/build/packages/paykit/packages/connectkit/src/assets/logos.d.ts +179 -0
  34. package/build/packages/paykit/packages/connectkit/src/assets/wallet.d.ts +4 -0
  35. package/build/packages/paykit/packages/connectkit/src/assets/wave.d.ts +2 -0
  36. package/build/packages/paykit/packages/connectkit/src/components/BalanceButton/index.d.ts +9 -0
  37. package/build/packages/paykit/packages/connectkit/src/components/Common/Alert/index.d.ts +6 -0
  38. package/build/packages/paykit/packages/connectkit/src/components/Common/Alert/styles.d.ts +2 -0
  39. package/build/packages/paykit/packages/connectkit/src/components/Common/Alert/types.d.ts +6 -0
  40. package/build/packages/paykit/packages/connectkit/src/components/Common/Avatar/index.d.ts +16 -0
  41. package/build/packages/paykit/packages/connectkit/src/components/Common/Avatar/styles.d.ts +2 -0
  42. package/build/packages/paykit/packages/connectkit/src/components/Common/BrowserIcon/index.d.ts +4 -0
  43. package/build/packages/paykit/packages/connectkit/src/components/Common/BrowserIcon/styles.d.ts +1 -0
  44. package/build/packages/paykit/packages/connectkit/src/components/Common/BrowserIcon/types.d.ts +3 -0
  45. package/build/packages/paykit/packages/connectkit/src/components/Common/Button/index.d.ts +4 -0
  46. package/build/packages/paykit/packages/connectkit/src/components/Common/Button/styles.d.ts +10 -0
  47. package/build/packages/paykit/packages/connectkit/src/components/Common/Button/types.d.ts +15 -0
  48. package/build/packages/paykit/packages/connectkit/src/components/Common/Chain/index.d.ts +8 -0
  49. package/build/packages/paykit/packages/connectkit/src/components/Common/Chain/styles.d.ts +4 -0
  50. package/build/packages/paykit/packages/connectkit/src/components/Common/ChainSelect/index.d.ts +3 -0
  51. package/build/packages/paykit/packages/connectkit/src/components/Common/ChainSelectDropdown/index.d.ts +9 -0
  52. package/build/packages/paykit/packages/connectkit/src/components/Common/ChainSelectDropdown/styles.d.ts +4 -0
  53. package/build/packages/paykit/packages/connectkit/src/components/Common/ChainSelectList/index.d.ts +4 -0
  54. package/build/packages/paykit/packages/connectkit/src/components/Common/ChainSelectList/styles.d.ts +9 -0
  55. package/build/packages/paykit/packages/connectkit/src/components/Common/ConnectorList/index.d.ts +2 -0
  56. package/build/packages/paykit/packages/connectkit/src/components/Common/ConnectorList/styles.d.ts +5 -0
  57. package/build/packages/paykit/packages/connectkit/src/components/Common/CopyToClipboard/CopyToClipboardIcon.d.ts +5 -0
  58. package/build/packages/paykit/packages/connectkit/src/components/Common/CopyToClipboard/index.d.ts +7 -0
  59. package/build/packages/paykit/packages/connectkit/src/components/Common/CustomQRCode/QRCode.d.ts +12 -0
  60. package/build/packages/paykit/packages/connectkit/src/components/Common/CustomQRCode/index.d.ts +6 -0
  61. package/build/packages/paykit/packages/connectkit/src/components/Common/CustomQRCode/styles.d.ts +6 -0
  62. package/build/packages/paykit/packages/connectkit/src/components/Common/CustomQRCode/types.d.ts +8 -0
  63. package/build/packages/paykit/packages/connectkit/src/components/Common/DynamicContainer/index.d.ts +7 -0
  64. package/build/packages/paykit/packages/connectkit/src/components/Common/FitText/index.d.ts +8 -0
  65. package/build/packages/paykit/packages/connectkit/src/components/Common/LazyImage/index.d.ts +8 -0
  66. package/build/packages/paykit/packages/connectkit/src/components/Common/Logo/index.d.ts +8 -0
  67. package/build/packages/paykit/packages/connectkit/src/components/Common/Logo/styles.d.ts +3 -0
  68. package/build/packages/paykit/packages/connectkit/src/components/Common/Modal/index.d.ts +25 -0
  69. package/build/packages/paykit/packages/connectkit/src/components/Common/Modal/styles.d.ts +24 -0
  70. package/build/packages/paykit/packages/connectkit/src/components/Common/OptionsList/index.d.ts +14 -0
  71. package/build/packages/paykit/packages/connectkit/src/components/Common/OptionsList/styles.d.ts +6 -0
  72. package/build/packages/paykit/packages/connectkit/src/components/Common/OrderHeader/index.d.ts +3 -0
  73. package/build/packages/paykit/packages/connectkit/src/components/Common/Portal/index.d.ts +3 -0
  74. package/build/packages/paykit/packages/connectkit/src/components/Common/ScrollArea/index.d.ts +7 -0
  75. package/build/packages/paykit/packages/connectkit/src/components/Common/ScrollArea/styles.d.ts +3 -0
  76. package/build/packages/paykit/packages/connectkit/src/components/Common/Spinner/index.d.ts +1 -0
  77. package/build/packages/paykit/packages/connectkit/src/components/Common/Spinner/styles.d.ts +1 -0
  78. package/build/packages/paykit/packages/connectkit/src/components/Common/ThemedButton/index.d.ts +15 -0
  79. package/build/packages/paykit/packages/connectkit/src/components/Common/ThemedButton/styles.d.ts +2 -0
  80. package/build/packages/paykit/packages/connectkit/src/components/Common/Tooltip/index.d.ts +4 -0
  81. package/build/packages/paykit/packages/connectkit/src/components/Common/Tooltip/styles.d.ts +3 -0
  82. package/build/packages/paykit/packages/connectkit/src/components/Common/Tooltip/types.d.ts +10 -0
  83. package/build/packages/paykit/packages/connectkit/src/components/ConnectButton/index.d.ts +36 -0
  84. package/build/packages/paykit/packages/connectkit/src/components/ConnectButton/styles.d.ts +4 -0
  85. package/build/packages/paykit/packages/connectkit/src/components/ConnectKit.d.ts +85 -0
  86. package/build/packages/paykit/packages/connectkit/src/components/ConnectKitThemeProvider/ConnectKitThemeProvider.d.ts +16 -0
  87. package/build/packages/paykit/packages/connectkit/src/components/ConnectModal/ConnectUsing.d.ts +2 -0
  88. package/build/packages/paykit/packages/connectkit/src/components/ConnectModal/ConnectWithInjector/index.d.ts +15 -0
  89. package/build/packages/paykit/packages/connectkit/src/components/ConnectModal/ConnectWithInjector/styles.d.ts +6 -0
  90. package/build/packages/paykit/packages/connectkit/src/components/ConnectModal/ConnectWithQRCode.d.ts +5 -0
  91. package/build/packages/paykit/packages/connectkit/src/components/ConnectModal/index.d.ts +9 -0
  92. package/build/packages/paykit/packages/connectkit/src/components/NetworkButton/index.d.ts +8 -0
  93. package/build/packages/paykit/packages/connectkit/src/components/Pages/About/graphics.d.ts +11 -0
  94. package/build/packages/paykit/packages/connectkit/src/components/Pages/About/index.d.ts +3 -0
  95. package/build/packages/paykit/packages/connectkit/src/components/Pages/About/styles.d.ts +8 -0
  96. package/build/packages/paykit/packages/connectkit/src/components/Pages/Confirmation/index.d.ts +3 -0
  97. package/build/packages/paykit/packages/connectkit/src/components/Pages/Connectors/index.d.ts +3 -0
  98. package/build/packages/paykit/packages/connectkit/src/components/Pages/Connectors/styles.d.ts +9 -0
  99. package/build/packages/paykit/packages/connectkit/src/components/Pages/DownloadApp/index.d.ts +2 -0
  100. package/build/packages/paykit/packages/connectkit/src/components/Pages/MobileConnectors/index.d.ts +3 -0
  101. package/build/packages/paykit/packages/connectkit/src/components/Pages/MobileConnectors/styles.d.ts +5 -0
  102. package/build/packages/paykit/packages/connectkit/src/components/Pages/Onboarding/index.d.ts +3 -0
  103. package/build/packages/paykit/packages/connectkit/src/components/Pages/Onboarding/styles.d.ts +9 -0
  104. package/build/packages/paykit/packages/connectkit/src/components/Pages/PayWithToken/index.d.ts +3 -0
  105. package/build/packages/paykit/packages/connectkit/src/components/Pages/Profile/index.d.ts +5 -0
  106. package/build/packages/paykit/packages/connectkit/src/components/Pages/Profile/styles.d.ts +6 -0
  107. package/build/packages/paykit/packages/connectkit/src/components/Pages/SelectMethod/index.d.ts +3 -0
  108. package/build/packages/paykit/packages/connectkit/src/components/Pages/SelectMethod/styles.d.ts +9 -0
  109. package/build/packages/paykit/packages/connectkit/src/components/Pages/SelectToken/index.d.ts +3 -0
  110. package/build/packages/paykit/packages/connectkit/src/components/Pages/SignInWithEthereum/index.d.ts +3 -0
  111. package/build/packages/paykit/packages/connectkit/src/components/Pages/SignInWithEthereum/styles.d.ts +5 -0
  112. package/build/packages/paykit/packages/connectkit/src/components/Pages/SwitchNetworks/index.d.ts +3 -0
  113. package/build/packages/paykit/packages/connectkit/src/components/Pages/WaitingOther/index.d.ts +4 -0
  114. package/build/packages/paykit/packages/connectkit/src/components/Pages/WaitingOther/styles.d.ts +9 -0
  115. package/build/packages/paykit/packages/connectkit/src/components/Spinners/CircleSpinner/index.d.ts +9 -0
  116. package/build/packages/paykit/packages/connectkit/src/components/Spinners/CircleSpinner/styles.d.ts +5 -0
  117. package/build/packages/paykit/packages/connectkit/src/components/Spinners/SquircleSpinner/index.d.ts +5 -0
  118. package/build/packages/paykit/packages/connectkit/src/components/Spinners/SquircleSpinner/styles.d.ts +4 -0
  119. package/build/packages/paykit/packages/connectkit/src/components/Standard/SIWE/index.d.ts +10 -0
  120. package/build/packages/paykit/packages/connectkit/src/components/Standard/SIWE/styles.d.ts +1 -0
  121. package/build/packages/paykit/packages/connectkit/src/components/contexts/web3/index.d.ts +25 -0
  122. package/build/packages/paykit/packages/connectkit/src/constants/chainConfigs.d.ts +18 -0
  123. package/build/packages/paykit/packages/connectkit/src/constants/defaultTheme.d.ts +4 -0
  124. package/build/packages/paykit/packages/connectkit/src/defaultConfig.d.ts +15 -0
  125. package/build/packages/paykit/packages/connectkit/src/defaultConnectors.d.ts +14 -0
  126. package/build/packages/paykit/packages/connectkit/src/defaultTransports.d.ts +15 -0
  127. package/build/packages/paykit/packages/connectkit/src/hooks/connectors/useCoinbaseWalletUri.d.ts +0 -0
  128. package/build/packages/paykit/packages/connectkit/src/hooks/connectors/useWalletConnectUri.d.ts +7 -0
  129. package/build/packages/paykit/packages/connectkit/src/hooks/useChainIsSupported.d.ts +1 -0
  130. package/build/packages/paykit/packages/connectkit/src/hooks/useChains.d.ts +2 -0
  131. package/build/packages/paykit/packages/connectkit/src/hooks/useConnect.d.ts +119 -0
  132. package/build/packages/paykit/packages/connectkit/src/hooks/useConnectCallback.d.ts +8 -0
  133. package/build/packages/paykit/packages/connectkit/src/hooks/useConnectors.d.ts +7 -0
  134. package/build/packages/paykit/packages/connectkit/src/hooks/useEnsFallbackConfig.d.ts +2 -0
  135. package/build/packages/paykit/packages/connectkit/src/hooks/useFitText.d.ts +15 -0
  136. package/build/packages/paykit/packages/connectkit/src/hooks/useFocusTrap.d.ts +1 -0
  137. package/build/packages/paykit/packages/connectkit/src/hooks/useGoogleFont.d.ts +3 -0
  138. package/build/packages/paykit/packages/connectkit/src/hooks/useIsMobile.d.ts +1 -0
  139. package/build/packages/paykit/packages/connectkit/src/hooks/useIsMounted.d.ts +1 -0
  140. package/build/packages/paykit/packages/connectkit/src/hooks/useLastConnector.d.ts +4 -0
  141. package/build/packages/paykit/packages/connectkit/src/hooks/useLocalStorage.d.ts +7 -0
  142. package/build/packages/paykit/packages/connectkit/src/hooks/useLocales.d.ts +1 -0
  143. package/build/packages/paykit/packages/connectkit/src/hooks/useLockBodyScroll.d.ts +2 -0
  144. package/build/packages/paykit/packages/connectkit/src/hooks/useModal.d.ts +12 -0
  145. package/build/packages/paykit/packages/connectkit/src/hooks/usePrevious.d.ts +1 -0
  146. package/build/packages/paykit/packages/connectkit/src/hooks/useWalletConnectModal.d.ts +4 -0
  147. package/build/packages/paykit/packages/connectkit/src/hooks/useWindowSize.d.ts +4 -0
  148. package/build/packages/paykit/packages/connectkit/src/index.d.ts +16 -0
  149. package/build/packages/paykit/packages/connectkit/src/localizations/index.d.ts +93 -0
  150. package/build/packages/paykit/packages/connectkit/src/localizations/locales/ar-AE.d.ts +3 -0
  151. package/build/packages/paykit/packages/connectkit/src/localizations/locales/ca-AD.d.ts +3 -0
  152. package/build/packages/paykit/packages/connectkit/src/localizations/locales/ee-EE.d.ts +3 -0
  153. package/build/packages/paykit/packages/connectkit/src/localizations/locales/en-US.d.ts +93 -0
  154. package/build/packages/paykit/packages/connectkit/src/localizations/locales/es-ES.d.ts +3 -0
  155. package/build/packages/paykit/packages/connectkit/src/localizations/locales/fa-IR.d.ts +3 -0
  156. package/build/packages/paykit/packages/connectkit/src/localizations/locales/fr-FR.d.ts +3 -0
  157. package/build/packages/paykit/packages/connectkit/src/localizations/locales/index.d.ts +2 -0
  158. package/build/packages/paykit/packages/connectkit/src/localizations/locales/ja-JP.d.ts +93 -0
  159. package/build/packages/paykit/packages/connectkit/src/localizations/locales/pt-BR.d.ts +3 -0
  160. package/build/packages/paykit/packages/connectkit/src/localizations/locales/ru-RU.d.ts +3 -0
  161. package/build/packages/paykit/packages/connectkit/src/localizations/locales/tr-TR.d.ts +3 -0
  162. package/build/packages/paykit/packages/connectkit/src/localizations/locales/vi-VN.d.ts +3 -0
  163. package/build/packages/paykit/packages/connectkit/src/localizations/locales/zh-CN.d.ts +3 -0
  164. package/build/packages/paykit/packages/connectkit/src/siwe/SIWEContext.d.ts +42 -0
  165. package/build/packages/paykit/packages/connectkit/src/siwe/SIWEProvider.d.ts +11 -0
  166. package/build/packages/paykit/packages/connectkit/src/siwe/index.d.ts +3 -0
  167. package/build/packages/paykit/packages/connectkit/src/siwe/useSIWE.d.ts +21 -0
  168. package/build/packages/paykit/packages/connectkit/src/styles/defaultTheme.d.ts +3 -0
  169. package/build/packages/paykit/packages/connectkit/src/styles/index.d.ts +1 -0
  170. package/build/packages/paykit/packages/connectkit/src/styles/styled/index.d.ts +12 -0
  171. package/build/packages/paykit/packages/connectkit/src/styles/themes/base.d.ts +130 -0
  172. package/build/packages/paykit/packages/connectkit/src/styles/themes/index.d.ts +680 -0
  173. package/build/packages/paykit/packages/connectkit/src/styles/themes/midnight.d.ts +75 -0
  174. package/build/packages/paykit/packages/connectkit/src/styles/themes/minimal.d.ts +95 -0
  175. package/build/packages/paykit/packages/connectkit/src/styles/themes/nouns.d.ts +80 -0
  176. package/build/packages/paykit/packages/connectkit/src/styles/themes/retro.d.ts +89 -0
  177. package/build/packages/paykit/packages/connectkit/src/styles/themes/rounded.d.ts +87 -0
  178. package/build/packages/paykit/packages/connectkit/src/styles/themes/soft.d.ts +70 -0
  179. package/build/packages/paykit/packages/connectkit/src/styles/themes/web95.d.ts +92 -0
  180. package/build/packages/paykit/packages/connectkit/src/styles/types.d.ts +80 -0
  181. package/build/packages/paykit/packages/connectkit/src/types.d.ts +13 -0
  182. package/build/packages/paykit/packages/connectkit/src/utils/getPaymentInfo.d.ts +101 -0
  183. package/build/packages/paykit/packages/connectkit/src/utils/index.d.ts +18 -0
  184. package/build/packages/paykit/packages/connectkit/src/utils/localstorage.d.ts +9 -0
  185. package/build/packages/paykit/packages/connectkit/src/utils/p3.d.ts +2 -0
  186. package/build/packages/paykit/packages/connectkit/src/utils/platform.d.ts +2 -0
  187. package/build/packages/paykit/packages/connectkit/src/utils/trpc.d.ts +957 -0
  188. package/build/packages/paykit/packages/connectkit/src/utils/wallets.d.ts +24 -0
  189. package/build/packages/paykit/packages/connectkit/src/wallets/index.d.ts +7 -0
  190. package/build/packages/paykit/packages/connectkit/src/wallets/useWallets.d.ts +9 -0
  191. package/build/packages/paykit/packages/connectkit/src/wallets/walletConfigs.d.ts +31 -0
  192. package/package.json +75 -0
package/LICENSE ADDED
@@ -0,0 +1,26 @@
1
+ BSD 2-Clause License
2
+
3
+ Copyright (c) 2022, Daimo, Inc.
4
+ Copyright (c) 2022, LFE, Inc.
5
+ All rights reserved.
6
+
7
+ Redistribution and use in source and binary forms, with or without
8
+ modification, are permitted provided that the following conditions are met:
9
+
10
+ 1. Redistributions of source code must retain the above copyright notice, this
11
+ list of conditions and the following disclaimer.
12
+
13
+ 2. Redistributions in binary form must reproduce the above copyright notice,
14
+ this list of conditions and the following disclaimer in the documentation
15
+ and/or other materials provided with the distribution.
16
+
17
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
21
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
23
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
24
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package/README.md ADDED
@@ -0,0 +1,77 @@
1
+ <!-- TODO -->
2
+ <!-- <a href="https://docs.family.co/connectkit">
3
+ <img width="1080" alt="connectkit" src="https://github.com/family/connectkit/assets/1930210/87c2e868-3228-44b8-82c3-a38adf6d1bbf">
4
+ </a> -->
5
+
6
+ # Daimo Pay
7
+
8
+ Daimo Pay is a powerful [React](https://reactjs.org/) component library for connecting a wallet to your dApp. It supports the most popular connectors and chains out of the box and provides a beautiful, seamless experience.
9
+
10
+ ## Features
11
+
12
+ - 💡 TypeScript Ready — Get types straight out of the box.
13
+ - 🌱 Ecosystem Standards — Uses top libraries such as [wagmi](https://github.com/wagmi-dev/wagmi).
14
+ - 🖥️ Simple UX — Give users a simple, attractive experience.
15
+ - 🎨 Beautiful Themes — Predesigned themes or full customization.
16
+
17
+ and much more...
18
+
19
+ ## Documentation
20
+
21
+ You can find the full ConnectKit documentation in the Family docs [here](https://docs.family.co/connectkit).
22
+
23
+ ## API Reference
24
+
25
+ You can find the full API Reference in the Family docs [here](https://docs.family.co/connectkit/api-reference).
26
+
27
+ ## Examples
28
+
29
+ There are various runnable examples included in this repository in the [examples folder](https://github.com/family/connectkit/tree/main/examples):
30
+
31
+ - [Create React App Example (TypeScript)](https://github.com/family/connectkit/tree/main/examples/cra)
32
+ - [Next.js Example (TypeScript)](https://github.com/family/connectkit/tree/main/examples/nextjs)
33
+ - [Vite Example (TypeScript)](https://github.com/family/connectkit/tree/main/examples/vite)
34
+
35
+ ### Try in CodeSandbox
36
+
37
+ You can try out some ConnectKit examples directly in your browser through CodeSandbox:
38
+
39
+ - [Create React App Example (TypeScript)](https://codesandbox.io/s/5rhqm0?file=/README.md)
40
+ - [Next.js (TypeScript)](https://codesandbox.io/s/qnvyqe?file=/README.md)
41
+ - [Vite Example (TypeScript)](https://codesandbox.io/s/4jtssh?file=/README.md)
42
+
43
+ ### Running Examples Locally
44
+
45
+ Clone the ConnectKit project and install the necessary dependencies:
46
+
47
+ ```sh
48
+ $ git clone git@github.com:family/connectkit.git
49
+ $ cd connectkit
50
+ $ yarn install
51
+ ```
52
+
53
+ and start the code bundler:
54
+
55
+ ```sh
56
+ $ yarn dev:connectkit
57
+ ```
58
+
59
+ and then simply select the example you'd like to run:
60
+
61
+ ```sh
62
+ $ yarn dev:vite # Vite
63
+ $ yarn dev:nextjs # Next.js
64
+ $ yarn dev:cra # Create React App
65
+ ```
66
+
67
+ ## Contribute
68
+
69
+ Before starting on anything, please have a read through our [Contribution Guidelines](https://github.com/family/connectkit/blob/main/CONTRIBUTING.md).
70
+
71
+ ## Twitter
72
+
73
+ Follow [@family](https://twitter.com/family) on Twitter for the latest updates on ConnectKit.
74
+
75
+ ## License
76
+
77
+ See [LICENSE](https://github.com/family/connectkit/blob/main/LICENSE) for more information.