Setup & Prerequisites
Welcome! This guide covers the essential setup required to start building with LearnCard. Following these steps will get your environment ready for our Quick Start and tutorials.
1. π§ Introduction
This guide will help you:
Set up your development environment
Install core SDKs and tools
Verify everything is working before your first credential issuance
Assumed Knowledge: You should be familiar with:
Basic terminal/command line use
JavaScript or TypeScript
Package managers like npm, yarn, or pnpm
All examples use modern JavaScript and run on Node.js.
2. π₯οΈ System Requirements
β
Supported OS
macOS (M1/M2/M3+ supported)
Windows (Use WSL for best results)
Linux (Ubuntu LTS recommended)
π§ Node.js + npm/yarn
Required version: Node.js v18.x or v20.x
Node.js includes npm by default.
π₯ Download Node.js
π Verify:
π§ Git
Git is required for cloning repositories and managing code.
π₯ Download Git
π Verify:
3. π€ Account Setup (Optional)
Developer Account
You do not need a developer account to complete the Quick Start.
You'll be using local/demo network capabilities for your first integration. For live network use later, you can create a developer profile.
API Keys
Not required for Quick Start.
Youβll need them later for:
Live network integrations
Custom signing authorities
Auth-granted service access
4. π¦ Install the Wallet SDK
To get started with the LearnCard Wallet SDK:
This installs the essential module to initialize LearnCard
5. π§ Install Essential Tools (Optional for Quick Start)
LearnCard CLI (Optional)
If you want to script or automate wallet actions via terminal:
π Verify:
β See CLI Documentation
Seed Phrases
You donβt need an external wallet for Quick Start. LearnCard uses secure, deterministic wallets derived from seed phrases. Youβll use an environment variable (SECURE_SEED
) for your first script.
6. π‘ Recommended Tools
Code Editor
We recommend Visual Studio Code
Helpful Extensions:
ESLint β Code quality
Prettier β Auto-formatting
dotenv β Recognizes environment variables in
.env
files
7. β
Check Your Setup
Run the following commands to confirm everything is ready:
Need help? Visit our Troubleshooting Guide or join the Community for support.
8. π Next Steps
Youβre ready to go!
π Proceed to the Quick Start: Issue Your First Digital Badge β
Last updated
Was this helpful?