User Tools

Early Adoption of V2

We are looking for early JSCAD V2 adopters. If you are interested in…

  • creating designs with JSCAD V2
  • researching and documenting any issues found with JSCAD V2
  • discussing API and issues with developers

Then, please read on.

To start, you must…

Follow these steps to install, and enable JSCAD

  1. change directory to
  2. run “git checkout V2”
  3. run “npm install”
  4. run “npm run bootstrap”
  5. run “npm test”

If everything runs successfully then the results of the test suites will be shown. This may take a long time if your computer does not have high specifications, but should finish.

In addition, a set of documentation for the V2 modeling API can be generated.

  1. run 'npm run docs'

And open 'index.html' found in the 'out' directory.

Now, you can start working with JSCAD V2.

To use JSCAD V2 via the CLI (command line interface)

  1. change directories to “packages/cli”
  2. run “nodejs ./cli”

To use JSCAD V2 via the WEB

  1. change directories to “packages/web”
  2. run “npm run dev”
  3. start a browser, and access the URL shown

To use JSCAD V2 via the DESKTOP (application)

  1. TBD

For those looking to grab these from NPM, there's some special setup required. The above packages have been published with the 'alpha' tag to NPM. These are 'alpha' releases and therefore projects need to specifically use this tag.

From the command line:

npm install @jscad/modeling@alpha

Inside NPM packages:

"dependencies": {
  "@jscad/modeling": "alpha"

We only ask a few things. First, if you have some issues then first read Summary of V2 Changes. Some things are very different in JSCAD V2. Second, try to work around the issue. If you cannot then please create a new issue at JSCAD GitHub, and add some details about the issue, as well as what you tried.

If you need to discuss an issue then please open a new Development Discussion.

By the way, you can also edit this page.

(Please do not change the User Guide, as V1 is still being used.)