This repository contains the default modules of the Source Academy and their documentation, deployed to the default module site at https://source-academy.github.io/modules.
The Source Academy and Source Academy @ NUS are configured to access the default module site when evaluating import directives.
Documentation of Source Academy modules.
See the modules wiki for more details.
| Term | Description |
|---|---|
| Module | A set of one bundle with the same name and some/no tabs. |
| Bundle | The suite of functions that are provided by the module. |
| Tab | A user interface used by the module. |
The following set of instructions explain how to clone and set up a copy of the modules code repository on your local development machine. Following the steps below will create a modules directory in your local development machine and install the necessary dependencies of the project.
You will need to have a stable version of NodeJS on your local development machine. We recommend using the latest LTS version. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.
You will also need to have a package manager for your project. We recommend using a stable version of Yarn as the repository pipelines are using the Yarn package manager as well. To install the Yarn package manager through NPM, you can run the following command.
npm install -g yarn
Clone the repository on your local development machine and navigate to it using your favourite command line or shell tool.
git clone https://github.com/source-academy/modules.git
cd modules
Install all the dependencies of the project into node_modules in the root folder of your project directory.
yarn install
The following set of instructions explain how to transpile and serve the modules from your local development machine's code repository. Following the steps below will transpile all the modules in your project directory into JavaScript files located in the build folder. Thereafter, you will serve all the contents of the build folder in a server on your local development machine.
To transpile the modules' files from src into JavaScript files in build, run the following command.
yarn run build
To start the server that serves all the contents of the build folder in the root directory of the project, run the following command. By default, running this command serves the contents of the build folder on http://localhost:8022.
yarn run serve
The following set of instructions explains how to use a local copy of the Source Academy frontend with a local copy of the modules code repository. Following the steps below will configure the environment of the Source Academy frontend to use your locally served modules instead of the publicly available ones. Doing this will allow you to develop and modify modules without affecting the currently publicly available ones.
You will need to already have a local instance of Source Academy frontend set up. If you do not, you can follow the instructions here to setup an instance of Source Academy frontend on your local development machine.
Ensure that the environment variable REACT_APP_MODULE_BACKEND_URL in the .env file of the Source Academy frontend is configured to the URL of the module site that you are trying to retrieve modules from. At the same time, make sure that the server hosting the modules site is running. By default, the local server started by running yarn run serve is on http://localhost:8022. The default modules are implemented in the repository https://github.com/source-academy/modules and deployed to the modules site https://source-academy.github.io/modules.
Upon starting the local instance of Source Academy frontend, the Source Academy will connect to the configured modules site.
Please refer to the Modules Development Guide located in the modules wiki here for more information regarding how to create your own module including its own bundle and tab.
