Source Academy Modules Repository

This repository contains the default modules of the Source Academy and their documentation, alongside all the libraries and tooling required for development.

The Source Academy and Source Academy @ NUS are configured to access the default module site when evaluating import directives.

If you are looking for the documentation for the default modules, that can be found here.

If you are a developer looking to do things like create a new bundle or work with the repository, the developer documentation can be found here.

Quick Links

Site	Link
Source Academy	https://sourceacademy.org
Default Modules Deployment	https://source-academy.github.io/modules
Default Modules Documentation	https://source-academy.github.io/modules/documentation
Developer Documentation	https://source-academy.github.io/devdocs
js-slang	https://github.com/source-academy/js-slang
Frontend	https://github.com/source-academy/frontend

Repository Structure

.
├── .github
│   ├── actions        // Custom Github Actions
│   └── workflow       // CI/CD Workflow files
├── build              // Output for compiled assets
├── devserver          // Development Server
├── docs               // Documentation Server
├── lib
│   ├── __test_mocks__ // Mock bundles and tabs used for testing
│   ├── buildtools     // Command line tools for bundles and tabs
│   ├── lintplugin     // ESLint Plugin
│   ├── markdown-tree  // Markdown-It plugin for generating directory trees
│   ├── modules-lib    // Common library for utilities used by bundles and tabs
│   └── repotools      // Repository wide tooling
├── src                // Code for bundles, tabs and java-slang
│   ├── bundles
│   ├── tabs
│   └── java
├── vitest.config.js   // Root Vitest Config
├── eslint.config.js   // ESLint Config
└── yarn.config.cjs    // Yarn Constraints file

Building the documentation server

1. Run the command: yarn workspaces focus @sourceacademy/modules-docserver
2. cd into the docs directory and run yarn dev.

You should now have a local copy of the modules' developer documentation running on your machine.