Developer documentation

Begin by reading the Development guidelines.

Introduction

The bookserver is the student-facing web app for Runestone. It was ported from the Runestone server. At this time, the bookserver contains all functions from the old web2py’s models/ajax.py, but doesn’t (yet) provide student-facing admin pages. TODO: more discussion on the porting process.

• Use a modern, high-performance web framework (FastAPI). Compare to other options and explain why this.

• async approach

• Goal of 100% test coverage (do we agree on this?)

• Well-documented in the code to enable collaboration / improve code quality

• How it fits with both Runestone Components and with the web2py instructor interface

• Roadmap

Web application

• BookServer web application
• Database migration using Alembic

Development support

• Testing for the BookServer
• pre_commit_check.py - Formatting, Lint, and Unittests
• pyproject.toml - Poetry configuration
• .gitignore - Ignores for Git
• .flake8 - Flake8 configuration
• mypy.ini - mypy configuration
• tox.ini
• .coveragerc - Configure code coverage

Documentation generation

• conf.py - Configuration file for BookServer documentation
• codechat_config.yaml - Configuration for a CodeChat project
• .readthedocs.yml - Read the Docs configuration file