Installing GoJS
GoJS has no external dependencies or build tooling, so getting up and running can be quite simple.
Try GoJS
Feel free to play around with our code examples throughout the learn pages and samples. There is no need to install anything -- just edit the code. For example, try changing a text string in this example's JavaScript code:
You can download these playgrounds as simple HTML files that will run locally.
Development vs Deployment
The GoJS library comes in both "debug" and "release" variations in the release directory:
- go.js, the standard runtime library, used for <script> tags or require.
- go-debug.js,
the same functionality as
go.js, but with more error checking, for use during development. - go.mjs and go-debug.mjs are the same functionality but as ECMAScript modules, for bundling or for Node.js.
- go-module.js and go-debug-module.js,
copies of the
*.mjsfiles.
We recommend that you use go-debug.js (or go-debug.mjs) while doing your initial development --
it is more likely to signal errors or provide meaningful error messages than when using go.js.
Always remember to look at the console log to see if there are any error or warning messages.
Using GoJS from a CDN
You can use GoJS directly from a CDN via a script tag:
- Latest release library:
"https://unpkg.com/gojs" - Latest v3.1 library:
"https://unpkg.com/[email protected]" - Latest debug library:
"https://unpkg.com/gojs/release/go-debug.js"
- Latest release library:
"https://cdn.jsdelivr.net/npm/gojs" - Latest v3.1 library:
"https://cdn.jsdelivr.net/npm/[email protected]" - Latest debug library:
"https://cdn.jsdelivr.net/npm/gojs/release/go-debug.js"
Installing via npm
You can also download GoJS via npm:
When importing the module, environments that support development/production
distinctions (like Vite) will automatically choose to use go-debug.js when developing
and go.js when building/bundling.
The contents of that package only include the library.
If you want to download the extensions, samples, or documentation, they are in the create-gojs-kit package.
Download its contents by executing:
GitHub
We also maintain a GitHub Repository of all libraries, documentation, samples, and extensions. This allows you to search through documentation and code online.
New versions
You can learn about new releases in several manners:
- read or follow the Northwoods GoJS Forum
- "watch" the GoJS GitHub repository for new releases
- read the GoJS npm package page, or write a "hook" for it
- follow us on Twitter: @NorthwoodsGo
- read the GoJS Change Log page (latest)
When updating or upgrading to a newer version, please read the Change Log.
Evaluation License Agreement
If you wish to use the GoJS library for your private evaluation, you may do so only under the terms of the Evaluation License Agreement. We encourage you to register if you discover you need technical support during your evaluation.
After purchasing a license, you may deploy by acquiring a license key for your web site's domain. See Deployment for more discussion.