Skip to main content
Ctrl+K
XBlock API Guide  documentation - Home XBlock API Guide  documentation - Home
  • Open edX XBlock API Guide
  • Change history for XBlock
  • Introduction to XBlocks
  • XBlock API
  • Fields API
  • Runtime API
  • Plugins API
  • Exceptions API
  • Open edX XBlock Tutorial
    • Introduction
    • XBlock Overview
      • Introduction to XBlocks
      • XBlock Examples
    • Build an XBlock: Quick Start
      • Install XBlock Prerequisites
      • Set Up the XBlock Software Development Kit
      • Create Your First XBlock
      • What Browsers Do I Need to Support?
    • Anatomy of an XBlock
      • The XBlock Python File
      • The XBlock HTML File
      • The XBlock JavaScript File
      • The XBlock Stylesheets
    • Customize Your XBlock
      • Customize myxblock.py
      • Customize myxblock.html
      • Customize myxblock.js
      • Customize myxblock.css
    • XBlock Concepts
      • XBlock Fields
      • XBlock Methods
      • XBlock Fragments
      • XBlock Children
      • XBlock Runtimes
      • XBlocks, Events, and Grading
    • XBlocks and the edX Platform
      • Open edX Studio as an XBlock Runtime
      • Open edX Learning Management System as an XBlock Runtime
      • Deploy Your XBlock in Devstack
      • Submit Your XBlock to edX
      • Replace a Preinstalled XBlock With a Custom Implementation
    • Open edX Glossary
    • Using XBlock Software Development Kit
      • Getting Started with the XBlock SDK
  • Xblock.utils
    • Settings and theme support
  • Repository
  • Suggest edit
  • Open issue
  • .rst

Build an XBlock: Quick Start

Build an XBlock: Quick Start#

This part of the tutorial guides you through building an XBlock. At the end, you will have the skeleton of an XBlock that you can then customize.

To continue, see the following sections.

  • Install XBlock Prerequisites
    • Python 3.12
    • Git
    • A Virtual Environment
  • Set Up the XBlock Software Development Kit
    • Create a Directory for XBlock Work
    • Create and Activate the Virtual Environment
    • Clone the XBlock Software Development Kit
  • Create Your First XBlock
    • Create an XBlock
    • Install the XBlock
    • Create the SQLite Database
    • Run the XBlock SDK Server
    • Next Steps
  • What Browsers Do I Need to Support?

previous

XBlock Examples

next

Install XBlock Prerequisites

By The Axim Collaborative

© Copyright 2026, The Axim Collaborative.

Creative Commons License
These works by The Axim Collaborative are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.