Installation - CodeVA-Curriculum/polyscribe-canvas GitHub Wiki

The polyscribe-canvas tool is a NodeJS script designed to run on Linux filesystems. In order to set up the tool, follow the steps for your operating system:

  1. Install NodeJS
  2. Install polyscribe-canvas as a global package

For some detailed instructions for setting up polyscribe-canvas, you can follow the instructions below. These instructions are written for beginners to NodeJS, and may not work for everyone.

Step 1: Installing Dependencies

Note for Windows Users: This tool is designed to work on Unix filesystems. If you plan to use polyscribe with a Windows machine, I highly recommend that you install it within the Windows Linux Subsystem (WSL). You can find detailed instructions for this on Microsoft's website.

First, install NodeJS. I use nvm to manage my Node versions, and I highly recommend you do the same. To install nvm, open a terminal and run the installation script from their website (the command copied below is up to date as of 1/9/2025):

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

After you've installed nvm, install NodeJS (I'm using 22.12.0, but it may work on other versions too):

nvm install 22.12.0

Test your installation by running the command below in your terminal:

node --version

Next, install polyscribe-canvas as a global package by running the following command:

npm install -g https://github.com/codeva-curriculum/polyscribe-canvas

This will give you access to the polyscribe command. Run it as shown below to make sure everything worked correctly:

polyscribe --help

After you have followed these steps, you are ready to create a course repository.