> For the complete documentation index, see [llms.txt](https://docs.joeywallet.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.joeywallet.xyz/overview/getting-started.md).

# Getting Started

Joey Wallet’s documentation is designed to help developers integrate the wallet into their dApps quickly and efficiently. Below is a rundown of the key sections in the Joey Wallet Developer Documentation, inspired by resources like [XRPL.org](http://XRPL.org) and Ledger’s Developer Portal.

#### 1. Introduction to Joey Wallet

* Overview: Learn about Joey Wallet’s core features, including its self-custodial nature, WalletConnect support, and compatibility with the XRP Ledger and Xahau Network.
* Why Joey Wallet?: Understand the benefits of integrating with Joey Wallet, such as its seamless UI/UX, fast onboarding, and robust security.
* Use Cases: Explore how Joey Wallet supports payments, DeFi, NFT trading, and other XRPL-based applications.

#### 2. Getting Started

* Setup Guide: Instructions for setting up a development environment, including required tools (e.g., Node.js, npm) and access to XRPL Testnet credentials for testing.
* WalletConnect Integration: A step-by-step guide to connecting Joey Wallet to your dApp using WalletConnect’s open-source protocol.
* API Overview: Introduction to Joey Wallet’s API and SDK for signing transactions and interacting with the XRPL.

See [here](/overview/quick-start.md) for our quick start, step-by-step guidelines.

#### 3. WalletConnect Integration

* What is WalletConnect?: A protocol for securely connecting mobile wallets to dApps via QR code-based authentication, ensuring private keys remain on the user’s device.
* Supported Wallets: Joey Wallet supports WalletConnect for seamless dApp interactions, similar to MetaMask or Trust Wallet for Ethereum-based dApps.
* Integration Steps:

  To get started with the Joey Wallet Provider, follow the steps below:

  1. **Install the Package:**

     Use pnpm to install the package:

     ```bash
     pnpm install @joey-wallet/wc-client
     ```
  2. **Initialize the Provider:**

     Initialize the provider using your credentials provided on the Reown Dashboard.
  3. **Manage Connections:**

     Use provider actions for handling connections:

     * `connect`
     * `generate`

     Utilize the provided `joey-modal` and `joey-button` components for seamless integration.

  By following these steps, you'll be set up to handle basic interactions with the Joey Wallet efficiently.

See [here](/integration/install.md) for our integration guidelines.

#### 4. Testing and Debugging

* Testnet Access: Use XRPL Testnet to develop and test your dApp without risking real funds. Generate Testnet credentials via [XRPL.org](http://XRPL.org).
* Troubleshooting: Common issues and solutions, such as handling WalletConnect connection errors or transaction failures.
* Best Practices: Guidelines for optimizing dApp performance and ensuring compatibility with Joey Wallet.

#### 5. Tutorials and Examples

* Step-by-Step Tutorials: Guides for common tasks, such as sending XRP, swapping tokens, or integrating with XRPL dApps like xrp.cafe.
* Sample Projects: Downloadable code examples for building XRPL dApps with Joey Wallet integration. (ie. wc-toolkit.joeywallet.xyz, joey-signer.vercel.app)
* Community Resources: Links to the XRPL developer community and forums for additional support.

See [here](https://github.com/Joey-Wallet/wc-client/tree/main/playground) for our playground of a few sample projects.

#### . Security and Best Practices

* Key Management: How Joey Wallet encrypts and stores private keys locally, audited by top firms.
* User Privacy: Ensuring no tracking or data collection, aligning with Joey Wallet’s privacy-first ethos.
* Secure Development: Tips for building secure dApps, including input validation and secure API calls.