Runestone Developer Documentation

• 1. Welcome
• 2. Quick Start: Run Your Own Runestone Server
• 3. Why Runestone Exists
• 4. What We Believe
  • 4.1. Active Learning First
  • 4.2. Students Are the Primary Beneficiary
  • 4.3. Open by Default
  • 4.4. Student Privacy is Non-Negotiable
  • 4.5. Accessibility is a Requirement
  • 4.6. Data Serves Learning
  • 4.7. Insight Over Data
  • 4.8. Interoperability Over Lock-In
  • 4.9. Pedagogy Drives Technology
  • 4.10. Empower Instructors
  • 4.11. Simplicity Enables Sustainability
  • 4.12. Focus is a Feature
  • 4.13. Built for Research
  • 4.14. Community Over Institution
  • 4.15. Anonymous Usage Telemetry
• 5. Runestone MonoRepo
  • 5.1. Docs
  • 5.2. Development Roadmap
  • 5.3. Contributing
  • 5.4. Our Community
• 6. Running a Runestone Server
  • 6.1. Prerequisites
  • 6.2. Quick Start
  • 6.3. Managing Your Server
  • 6.4. Updating Runestone
  • 6.5. Developer Setup (From Cloned Repository)
  • 6.6. How the Setup Script Works
• 7. Working on Runestone: Overview
  • 7.1. Getting started with Runestone Development
  • 7.2. Deploying a production version
• 8. Development Environment Pre-Requisites
  • 8.1. Poetry
  • 8.2. Docker
  • 8.3. Node and NPM
• 9. The Runestone Code
  • 9.1. Getting the Code
  • 9.2. Project File Structure
• 10. Docker and Environment Setup
  • 10.1. Installing Docker
  • 10.2. Docker files
• 11. Database setup
  • 11.1. Install Postgresql with docker-compose
  • 11.2. Install Postgresql locally
  • 11.3. Database migrations
• 12. Environment Variables Setup
  • 12.1. Make a .env File
  • 12.2. Setup .env Values
• 13. Building and Running the Servers
  • 13.1. Starting the Servers
  • 13.2. Using Docker to Manage Containers
  • 13.3. Connecting to the Server
  • 13.4. Using the build script
  • 13.5. Keeping the Servers Up to Date
• 14. Adding a Book
  • 14.1. Prerequisites
  • 14.2. Building the Book
• 15. Customizing a Textbook on Runestone Academy
  • 15.1. Getting Started
• 16. Contributing to the Runestone Project
  • 16.1. Getting started
  • 16.2. Code Style and Linting: Getting your PR merged
• 17. Adding a New Feature Server Side
• 18. Single Endpoint Fast Turnaround Development
• 19. Static Assets
• 20. Developing the Javascript for Runestone Components
• 21. Question JSON Schema
  • 21.1. Purpose
  • 21.2. Source of Truth
  • 21.3. Supported Question Types
  • 21.4. Field Reference
  • 21.5. Sub-Object Schemas
  • 21.6. Per-Question-Type Field Mapping
  • 21.7. Full Example JSON Objects
  • 21.8. Default Values
  • 21.9. Implementation Notes
• 22. Adding a new programming language
  • 22.1. Jobe
  • 22.2. PreTeXt
  • 22.3. Runestone
• 23. Tutorial: Adding a new Service
  • 23.1. Creating a new project
  • 23.2. Setting up the environment
  • 23.3. Adding a Template
  • 23.4. Setting up Docker
  • 23.5. Other References
• 24. When Things are not Working - Debugging Tips
  • 24.1. Interactive Testing with ipython
  • 24.2. Check the values in the database
  • 24.3. Using the Javascript Console
  • 24.4. Reporting Problems
• 25. Moving to Production
  • 25.1. Running your own server? Let us know
  • 25.2. Dealing with HTTPS and secure cookies
• 26. Document Plan
  • 26.1. Core instructions
  • 26.2. Development instructions
  • 26.3. Going to Production

API Documentation

Contents:

• Bases
  • 1. book_server_api package
  • 2. rsmanage package
• Components
  • 1. cl_utils package
  • 2. configuration package
  • 3. db package
  • 4. logging package
  • 5. response_helpers package
  • 6. Templates
  • 7. validation package

Indices and tables

• Index

• Module Index

• Search Page