/perseus

Perseus is Khan Academy's exercise question editor and renderer.

Primary LanguageTypeScriptMIT LicenseMIT

Perseus

perseus logo

Perseus Exercise Renderer

Perseus is Khan Academy's exercise system. This repo contains the code needed to take a problem in the perseus format and present it, allow interaction, and grade the result of a learner's work.

sample of perseus in use

This repo is a constellation of sub-repos for showing exercise content. Please see individual projects in in the packages/ folder for more information about each sub-project.

Getting started

Prerequisites

Installation

To install perseus, you need to run the following commands:

yarn install

Installs project dependencies

Using Storybook

The components and widgets of perseus are devleoped using Storybook. After you clone the project and get dependencies installed, the next step is to start storybook by running yarn storybook. This will start a server and give you a playground to use each component.

Using Changesets

We use changesets to help manage our versioning/releases. Before pushing a new PR, add a changeset by running yarn changeset. Commit and submit that with the PR.

Contributing

The Perseus project is not accepting external contributions. We’re releasing the code for others to refer to and learn from, but we are not open to pull requests or issues at this time.

License

MIT License