Skip to content

ChainLearnOfficial/chainlearn-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ChainLearn Documentation

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.

Quick Links

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)

Platform Overview

ChainLearn combines three technologies:

  1. AI-generated content -- Courses, quizzes, and feedback are generated by Cohere's language models, ensuring fresh and personalized learning material.
  2. Stellar blockchain -- Rewards (SEP-41 tokens) and credentials (NFTs) are issued on-chain via Soroban smart contracts, giving learners portable, verifiable proof of achievement.
  3. Traditional web stack -- A React frontend, Node.js API, and PostgreSQL database handle the user experience, authentication, and content management.

Repository Map

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

Getting Started

New to ChainLearn? Start here:

  1. Read the Architecture Overview to understand the system
  2. Follow the Local Development Guide to set up your environment
  3. Review the Contributing Guide before submitting changes

License

Documentation is licensed under CC BY 4.0. Code examples are MIT licensed.

About

Documentation for the ChainLearn platform — architecture, APIs, and user guides.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors