|
| 1 | +# Bloque SDK Documentation |
| 2 | + |
| 3 | +Official documentation for the Bloque SDK. |
| 4 | + |
| 5 | +## Overview |
| 6 | + |
| 7 | +This documentation covers the **@bloque/sdk** - a TypeScript/JavaScript SDK for integrating Bloque services into your applications. |
| 8 | + |
| 9 | +The SDK provides modules for: |
| 10 | + |
| 11 | +- **Organizations** (`@bloque/sdk-orgs`): Organization management |
| 12 | +- **Compliance** (`@bloque/sdk-compliance`): KYC/KYB compliance services |
| 13 | +- **Accounts** (`@bloque/sdk-accounts`): Account and virtual card management |
| 14 | +- **Identity** (`@bloque/sdk-identity`): User identity and authentication |
| 15 | +- **Core** (`@bloque/sdk-core`): Base client and shared utilities |
| 16 | + |
| 17 | +## Languages |
| 18 | + |
| 19 | +The documentation is available in: |
| 20 | + |
| 21 | +- English (`/en`) |
| 22 | +- Spanish (`/es`) |
| 23 | + |
| 24 | +## Setup |
| 25 | + |
| 26 | +Install the dependencies: |
| 27 | + |
| 28 | +```bash |
| 29 | +bun install |
| 30 | +``` |
| 31 | + |
| 32 | +## Get started |
| 33 | + |
| 34 | +Start the dev server: |
| 35 | + |
| 36 | +```bash |
| 37 | +bun run dev |
| 38 | +``` |
| 39 | + |
| 40 | +The documentation will be available at `http://localhost:5173` |
| 41 | + |
| 42 | +Build the website for production: |
| 43 | + |
| 44 | +```bash |
| 45 | +bun run build |
| 46 | +``` |
| 47 | + |
| 48 | +Preview the production build locally: |
| 49 | + |
| 50 | +```bash |
| 51 | +bun run preview |
| 52 | +``` |
| 53 | + |
| 54 | +## Documentation Structure |
| 55 | + |
| 56 | +``` |
| 57 | +docs/ |
| 58 | +├── en/ # English documentation |
| 59 | +│ ├── guide/ # Getting started guide |
| 60 | +│ │ ├── start/ # Quick start |
| 61 | +│ │ ├── features/ # SDK features |
| 62 | +│ │ ├── accounts/ # Account management |
| 63 | +│ │ └── examples/ # Code examples |
| 64 | +│ └── index.md # Home page |
| 65 | +└── es/ # Spanish documentation |
| 66 | + ├── guide/ # Guía de inicio |
| 67 | + │ ├── start/ # Inicio rápido |
| 68 | + │ ├── features/ # Características del SDK |
| 69 | + │ ├── accounts/ # Gestión de cuentas |
| 70 | + │ └── examples/ # Ejemplos de código |
| 71 | + └── index.md # Página de inicio |
| 72 | +``` |
| 73 | + |
| 74 | +## Content |
| 75 | + |
| 76 | +### Getting Started |
| 77 | +- Installation guide |
| 78 | +- Quick start examples |
| 79 | +- Platform support (Node.js, Bun, Deno, Browser) |
| 80 | +- User sessions and authentication |
| 81 | + |
| 82 | +### Features |
| 83 | +- Organizations management |
| 84 | +- Compliance (KYC/KYB) |
| 85 | +- Account management |
| 86 | +- Virtual cards |
| 87 | +- Identity registration |
| 88 | +- User sessions |
| 89 | + |
| 90 | +### Examples |
| 91 | +- Backend integration examples |
| 92 | +- Virtual card creation |
| 93 | +- User registration flows |
| 94 | +- Session management |
| 95 | + |
| 96 | +## Technology |
| 97 | + |
| 98 | +Built with [Rspress](https://rspress.dev/) - Fast Rspack-based documentation framework |
| 99 | + |
| 100 | +## Repository |
| 101 | + |
| 102 | +GitHub: [bloque-app/sdk](https://github.com/bloque-app/sdk) |
| 103 | +NPM: [@bloque/sdk](https://www.npmjs.com/package/@bloque/sdk) |
0 commit comments