Skip to content

Commit 23e1668

Browse files
committed
Update folder structure
1 parent 200e85c commit 23e1668

File tree

435 files changed

+40038
-63065
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

435 files changed

+40038
-63065
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,4 +149,5 @@ yarn-error.log
149149
!.yarn/versions
150150
.DS_Store
151151
build/
152-
Pods/
152+
Pods/
153+
.vscode/

.vscode/settings.json

Lines changed: 0 additions & 25 deletions
This file was deleted.

README.md

Lines changed: 112 additions & 195 deletions
Large diffs are not rendered by default.

README_TEMPLATE.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# Web3Auth {EXAMPLE_NAME} Example
2+
3+
This example demonstrates how to integrate Web3Auth's Plug and Play Modal SDK with {FRAMEWORK/PLATFORM} for {BLOCKCHAIN/FEATURE} integration. It provides a simple, production-ready starting point for adding Web3Auth authentication to your application.
4+
5+
## Quick Start
6+
7+
### 1. Clone the repository
8+
```bash
9+
git clone https://github.com/Web3Auth/web3auth-pnp-examples.git
10+
```
11+
12+
### 2. Navigate to the example
13+
```bash
14+
cd web3auth-pnp-examples/{EXAMPLE_PATH}
15+
```
16+
17+
### 3. Install dependencies
18+
```bash
19+
npm install
20+
# or
21+
yarn
22+
```
23+
24+
### 4. Configure environment variables
25+
Create a `.env` file and add your Web3Auth Client ID (get one from [Web3Auth Dashboard](https://dashboard.web3auth.io))
26+
```bash
27+
VITE_WEB3AUTH_CLIENT_ID=your-client-id
28+
```
29+
30+
### 5. Run the application
31+
```bash
32+
npm run dev
33+
# or
34+
yarn dev
35+
```
36+
37+
## Important Links
38+
- [Website](https://web3auth.io)
39+
- [Documentation](https://web3auth.io/docs)
40+
- [Guides](https://web3auth.io/docs/guides)
41+
- [SDK / API References](https://web3auth.io/docs/sdk)
42+
- [Pricing](https://web3auth.io/pricing.html)
43+
- [Support](https://discord.gg/web3auth)
44+
45+
## Technical Details
46+
47+
### Stack
48+
- Framework: {FRAMEWORK} {VERSION}
49+
- Web3Auth SDK: `@web3auth/modal@{VERSION}`
50+
- Blockchain: {BLOCKCHAIN}
51+
- Package Manager: npm/yarn
52+
- Build Tool: {BUILD_TOOL}
53+
54+
### Key Features
55+
- Social login with Web3Auth Modal UI
56+
- {BLOCKCHAIN} integration with {LIBRARY}
57+
- Example blockchain interactions:
58+
- Get user's address
59+
- Get user's balance
60+
- Sign messages
61+
- Send transactions
62+
{ADD_MORE_FEATURES}
63+
64+
### Code Structure
65+
```
66+
src/
67+
├── components/ # React components
68+
├── config/ # Configuration files
69+
├── services/ # Web3Auth and blockchain services
70+
└── App.{tsx/jsx} # Main application component
71+
```
72+
73+
### Web3Auth Configuration
74+
```typescript
75+
const web3AuthConfig = {
76+
clientId: import.meta.env.VITE_WEB3AUTH_CLIENT_ID,
77+
web3AuthNetwork: "sapphire_devnet",
78+
chainConfig: {
79+
chainNamespace: "{CHAIN_NAMESPACE}",
80+
chainId: "{CHAIN_ID}",
81+
rpcTarget: "{RPC_URL}"
82+
}
83+
};
84+
```
85+
86+
## Security Considerations
87+
- Keep your Web3Auth Client ID secure and never commit it to version control
88+
- Implement proper error handling for authentication and blockchain interactions
89+
- Follow blockchain security best practices when handling transactions
90+
- Consider implementing rate limiting for authentication attempts
91+
92+
## Support and Feedback
93+
- [Discord](https://discord.gg/web3auth)
94+
- [GitHub Issues](https://github.com/Web3Auth/web3auth-pnp-examples/issues)
95+
- [Documentation](https://web3auth.io/docs/connect-blockchain/{BLOCKCHAIN_DOC_PATH})
96+
97+
## License
98+
MIT

account-abstraction/aa-non-hooks-example/README.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)