Get Started - q5js/q5.js GitHub Wiki

q5 Web Editor

I highly recommend using the q5 Web Editor, which lets you create and share your q5 projects online!

  • easy to use minimalist interface
  • inline documentation for q5 WebGPU
  • advanced auto-complete
  • virtual file system with folders
  • top-notch JavaScript module support
  • no installation required

Launch the q5 Web Editor:

👉 https://codevre.com/q5-editor 🚀

HTML

To use q5 WebGPU in your own HTML, be sure to set the script type to "module".

<script type="module" src="https://q5js.org/q5.js"></script>

<script type="module" src="sketch.js"></script>

Package Managers

q5 is also available on npm and jsr.

<script type="module" src="node_modules/q5/q5.js"></script>

To get advanced autocompletion and inline documentation, simply add this jsconfig.json file to your project folder:

{
  "compilerOptions": {
    "target": "ESNext"
  },
  "typeAcquisition": {
    "include": ["node_modules/q5"]
  }
}

Server Templates

q5 can also be used server side with node, bun, or deno!

https://github.com/q5js/q5-node-template
https://github.com/q5js/q5-deno-template

⚠️ **GitHub.com Fallback** ⚠️