Skip to content

edly-io/sparkth

Repository files navigation

Sparkth

Sparkth is a free, open source, extensible, science-driven, AI-first learning platform. It is under active development by Edly.

This repository is organized as a Cargo workspace with three main components:

  • mcp/: a binary crate that runs the MCP server, responsible for creating courses from the chat UI of AI providers
  • backend/api/: a binary crate that serves HTTP APIs
  • backend/core/: a library crate for database access (PostgreSQL via Diesel)

Roadmap:

  • Native Rust API for integration of Sparkth into other applications.
  • Development of a new webassembly-based standard for the creation of next-gen learning experiences.

Installation

Pre-built binaries

We provides binaries for macOS (x86_64 & aarch64), Linux (x86_64) and Windows (x86_64). They are published automatically for every version tag (vX.Y.Z) on GitHub under Releases. Each archive contains:

  • Platform-specific binary (sparkth or sparkth.exe)
  • .zip and .tar.gz formats
  • SHA-256 checksums

Download from the CLI:

export sparkth_version=$(curl -s https://api.github.com/repos/edly-io/sparkth/releases/latest | sed -n 's/.*"tag_name": "\([^"]*\)".*/\1/p')

# Linux
curl -LO -o sparkth.tar.gz https://github.com/edly-io/sparkth/releases/download/$sparkth_version/sparkth-$sparkth_version-x86_64-unknown-linux-gnu.tar.gz
# macOS arm64
curl -LO -o sparkth.tar.gz https://github.com/edly-io/sparkth/releases/download/$sparkth_version/sparkth-$sparkth_version-aarch64-apple-darwin.tar.gz
# macOS x86_64
curl -LO -o sparkth.tar.gz https://github.com/edly-io/sparkth/releases/download/$sparkth_version/sparkth-$sparkth_version-x86_64-apple-darwin.tar.gz
# Windows
curl -LO -o sparkth.zip https://github.com/edly-io/sparkth/releases/download/$sparkth_version/sparkth-$sparkth_version-x86_64-pc-windows-msvc.zip

# Decompress
# For Linux/macOS:
tar -xzf sparkth.tar.gz
# For Windows:
unzip sparkth.zip

# Set execution mode (Linux/macOS only)
chmod a+x sparkth

# Smoke test
./sparkth --help

Building

The build guides are provided here:

  1. MCP documentation
  2. Backend documentation

Development

Build in development mode:

cargo build

Run tests:

cargo test

License

This project is licensed under the MIT License — see the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •  

Languages