Difficulty: Beginner
Estimated Time: 10 minutes

Using the Bash command line and the Node environment, this scenario includes the following steps:

  • Install the Core with NPM
  • Import the Entire Core Package
  • Import Individual Modules
  • Explore the Core

Understanding the Prompts

$ Bash Terminal

This prompt is for the Bash terminal on a linux server.

> Node Environmal

This prompt is for the Node environment and using Javascript commands.

About

Author: https://SteveSlevinski.me
Support: https://patreon.com/signwriting

Thanks for reviewing "Installing the Sutton SignWriting Core with NPM"

About

Author: https://SteveSlevinski.me
Support: https://patreon.com/signwriting

Installing the Sutton SignWriting Core with NPM

Step 1 of 4

Install the Core with NPM

The Sutton SignWriting Core can be installed with a single npm statement. Click the statement below.

npm install @sutton-signwriting/core --silent

View the Package Files

The source and distribution files can be found in the node_modules directory.

cd /root/node_modules/@sutton-signwriting/core
ls -l

Distribution Files

  • .js - Universal Module Definition
  • .cjs - CommonJS
  • .mjs - ES Module

Minified Package Distribution

There are three minified versions of the @sutton-signwriting/core package available for distribution.

cd /root/node_modules/@sutton-signwriting/core
ls -l *min*

Minified Module Distribution

Rather than using the entire package, you can use one of the six modules instead.

cd /root/node_modules/@sutton-signwriting/core
ls -l */*min*

View the Source

The source is fully documented and tested. Each function is available in a small file.

cd /root/node_modules/@sutton-signwriting/core/src
ls -l
Terminal
visualize
distribution
documentation