Skip to content

Commit

Permalink
Merge pull request #11 from tkey/readme-links-fixes
Browse files Browse the repository at this point in the history
Restructure and update readmes + fix links
  • Loading branch information
shahbaz17 authored Sep 21, 2023
2 parents a1e49d6 + 53f34a0 commit 09cd31f
Show file tree
Hide file tree
Showing 74 changed files with 37 additions and 101 deletions.
5 changes: 5 additions & 0 deletions .prettierrc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# .prettierrc or .prettierrc.yaml
printWidth: 150
singleQuote: false
semi: true
trailingComma: es5
23 changes: 5 additions & 18 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,12 @@
{
"editor.codeActionsOnSave": {
"source.fixAll": true
},
"eslint.workingDirectories": [
{
"directory": "web-no-modal-sdk/**/*",
"directory": "tkey-mpc-web/**/*",
"changeProcessCWD": true
},
{
"directory": "web-modal-sdk/**/*",
"changeProcessCWD": true
},
{
"directory": "wagmi-connector/*",
"changeProcessCWD": true
},
{
"directory": "single-factor-auth/*",
"changeProcessCWD": true
}
],
"cSpell.words": [
"appspot",
"firebaseapp",
"Sfaprovider"
]
"cSpell.words": []
}
89 changes: 6 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Web3Auth Core Kit Examples
# Web3Auth - MPC Examples

[Web3Auth](https://web3auth.io) is a plugable auth infrastructure for Web3 wallets and applications. It streamlines the
onboarding of both mainstream and crypto native users under a minute by providing experiences that they're most
Expand All @@ -24,92 +24,15 @@ results in a standard cryptographic key provider specific to the user and applic

| SDK | Lang Framework | Directory |
| :---------------------------- | :------------- | :--------------------------------------------------------------------- |
| `tKey` - MPC PopUp FLow | `REACT` | [MPC PopUp Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit/tkey-mpc-react-popup-example/) |
| `tKey` - MPC Firebase Example | `REACT` | [MPC Firebase Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit/tkey-mpc-react-firebase-example/) |
| `tKey` - MPC Bitcoin Example | `REACT` | [MPC Bitcoin Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit/tkey-mpc-react-bitcoin-example/) |

### Web: MPC Core Kit

| SDK | Lang Framework | Directory |
| :------------------------------------------- | :------------- | :----------------------------------------------------------------------------------------- |
| `tKey` - MPC CoreKit PopUp FLow | `REACT` | [MPC CoreKit PopUp Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit/mpc-core-kit-react-popup-example/) |
| `tKey` - MPC CoreKit PopUp Aggregate Example | `REACT` | [MPC CoreKit Aggregate Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit/mpc-core-kit-react-popup-aggregate-example/) |
| `tKey` - MPC CoreKit Redirect Example | `REACT` | [MPC CoreKit Redirect Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/mpc-core-kit/mpc-core-kit-react-redirect-example/) |

## Web3Auth SSS SDK Examples

### tKey SDKs

#### Web: tKey JS - SSS

| SDK | Lang Framework | Directory |
| :--------------------- | :------------- | :-------------------------------------------------------------------- |
| `tKey` - PopUp FLow | `REACT` | [tKey-React-Popup-Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-web/tkey-react-popup-example/) |
| `tKey` - Redirect FLow | `REACT` | [tKey-React-Redirect-Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-web/tkey-react-redirect-example/) |

#### Mobile: tKey Android SDK

| SDK | Lang Framework | Directory |
| :----- | :----------------------- | :------------------------------------------------------------------------ |
| `tKey` | `Android` Google Example | [tKey Android Google Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-android/tkey-android-google-example/) |
| `tKey` | `Android` Auth0 Example | [tKey Android Auth0 Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-android/tkey-android-auth0-example/) |

#### Mobile: tKey iOS SDK

| SDK | Lang Framework | Directory |
| :----- | :---------------------- | :------------------------------------------------------------------ |
| `tKey` | `iOS` Google Example | [tKey iOS Google Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-ios/tkey-ios-google-example/) |
| `tKey` | `iOS` Auth0 Example | [tKey iOS Auth0 Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-ios/tkey-ios-auth0-example/) |
| `tKey` | `iOS` Firebase Example | [tKey iOS Firebase Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-ios/tkey-ios-firebase-example/) |
| `tKey` | `iOS` Aggregate Example | [tKey iOS Aggregate Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-ios/tkey-ios-aggregate-example/) |

#### Mobile: tKey React Native SDK

| SDK | Lang Framework | Directory |
| :----- | :------------------------------ | :------------------------------------------------------------------------------------------- |
| `tKey` | `React Native` Firebase Example | [tKey React Native Firebase Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-react-native/tkey-react-native-firebase-example/) |
| `tKey` | `React Native` Auth0 Example | [tKey React Native Auth0 Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/tkey-react-native/tkey-rn-expo-auth0-example/) |

### Single Factor Auth SDKs

#### Web: Single Factor Auth Web SDK

| SDK | Lang Framework | Directory |
| :---- | :------------- | :------------------------------------------------------------------------------------------ |
| `SFA` | `REACT` | [single-factor-auth-React-One-Key-with-NoModal](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/sfa-one-key-flow-example/) |
| `SFA` | `REACT` | [single-factor-auth-React](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/sfa-react-example/) |
| `SFA` | `REACT` | [single-factor-auth-Vite](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-web/sfa-react-vite-example/) |

#### Web Backend: Node SDK

| SDK | Lang Framework | Directory |
| :----- | :------------- | :----------------------------------------- |
| `Node` | `JS` | [Node JS Backend Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/node-sdk/node-backend-example/) |

#### Mobile: Single Factor Auth Android SDK

| SDK | Lang Framework | Directory |
| :---- | :------------- | :---------------------------------------------------------------------------------------------- |
| `SFA` | `Android` | [Single Factor Auth Android Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-android/android-sfa-firebase-example/) |

#### Mobile: Single Factor Auth iOS SDK

| SDK | Lang Framework | Directory |
| :---- | :------------- | :---------------------------------------------------------------------------------- |
| `SFA` | `iOS` | [Single Factor Auth iOS Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-ios/ios-sfa-firebase-example/) |

#### Mobile: Single Factor Auth React Native SDK

| SDK | Lang Framework | Directory |
| :---- | :------------------------------ | :---------------------------------------------------------------------------------------------------------------------- |
| `SFA` | `React Native` Firebase Example | [Single Factor Auth React Native Firebase Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-react-native/sfa-react-native-firebase-example/) |
| `SFA` | `React Native` Auth0 Example | [Single Factor Auth React Native Auth0 Example](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/single-factor-auth-react-native/sfa-rn-expo-auth0-example/) |
| `tKey` - MPC PopUp FLow | `REACT` | [MPC PopUp Example](/tkey-mpc-web/tkey-mpc-react-popup-example/) |
| `tKey` - MPC Firebase Example | `REACT` | [MPC Firebase Example](/tkey-mpc-web/tkey-mpc-react-firebase-example/) |
| `tKey` - MPC Bitcoin Example | `REACT` | [MPC Bitcoin Example](/tkey-mpc-web/tkey-mpc-react-bitcoin-example/) |

## Questions

Ask us on our [Community Forum](https://community.web3auth.io/) or reach out to our
Ask us on our [Community Forum](https://community.web3auth.io) or reach out to our
[Discord](https://discord.gg/web3auth).

## License

[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/Web3Auth/web3auth-core-kit-examples/tree/main/LICENSE)
[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](/LICENSE)
21 changes: 21 additions & 0 deletions mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"httpHeaders": [
{
"urls": [
"https://github.com/",
"https://guides.github.com/",
"https://help.github.com/",
"https://docs.github.com/"
],
"headers": {
"Accept-Encoding": "zstd, br, gzip, deflate"
}
}
],
"replacementPatterns": [
{
"pattern": "^/",
"replacement": "https://github.com/tkey/tkey-mpc-examples/tree/main/"
}
]
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 09cd31f

Please sign in to comment.