ChainLearn is a Stellar-based AI-powered learning platform that rewards learners with on-chain tokens and verifiable credentials. This repository contains the canonical documentation for all ChainLearn services, smart contracts, APIs, and architectural decisions.
| Section | Description |
|---|---|
| Architecture Overview | System design, repo structure, tech stack |
| Data Flow | End-to-end flow from enrollment to credential |
| Smart Contracts | Contract design decisions and rationale |
| API Reference | OpenAPI specs for all services |
| Contract Docs | Learn Token, Credential NFT, Progress Tracker |
| Guides | Local dev, deployment, contributing |
| Decision Records | Architecture Decision Records (ADRs) |
ChainLearn combines three technologies:
- AI-generated content -- Courses, quizzes, and feedback are generated by Cohere's language models, ensuring fresh and personalized learning material.
- Stellar blockchain -- Rewards (SEP-41 tokens) and credentials (NFTs) are issued on-chain via Soroban smart contracts, giving learners portable, verifiable proof of achievement.
- Traditional web stack -- A React frontend, Node.js API, and PostgreSQL database handle the user experience, authentication, and content management.
The ChainLearn platform spans seven repositories:
| Repository | Purpose |
|---|---|
chainlearn-frontend | React + TypeScript SPA |
chainlearn-api | Express REST API and auth layer |
chainlearn-ai | Python AI service (Cohere integration) |
chainlearn-contracts | Soroban smart contracts (Rust) |
chainlearn-indexer | Event indexer for on-chain data |
chainlearn-docs | This documentation |
chainlearn-infra | Terraform + Docker infrastructure |
New to ChainLearn? Start here:
- Read the Architecture Overview to understand the system
- Follow the Local Development Guide to set up your environment
- Review the Contributing Guide before submitting changes
Documentation is licensed under CC BY 4.0. Code examples are MIT licensed.