This template is designed to get you developing a Script for Meraki as quickly as possible.
Your project must contain at least two files - Script.js and ScriptTraits.js. See the SDK documentation for more a comprehensive description of the requirements when using the SDK.
To get started, run the setup command below and you can jump right into developing a P5.js, three.js, or plain javascript script for Meraki using our SDK.
To get started, you need to install the project dependencies:
npm installTo enhance your development experience, Meraki provides a web service that validates your scripts.
To run the script checks on your Script.js file:
npm run check:scriptand for your ScriptTraits.js file:
npm run check:traitsYou should see output similar to the following:
To start a web server that will display the current rendering of your script, run:
npm run serveOpen the url generated by this command in your browser to view your rendered image.
You may initially see the dashboard - simply select the item that applies to your script:
To bundle your project's source code into a zip archive for submission to Meraki:
npm run bundle
You may then submit the newly created project.zip file on the Meraki project dashboard:
Uploading the file does not submit it for review - it streamlines the process of getting your code into the platform, where they can be edited, rendered and submitted for review.
Please see CHANGELOG for more information on what has changed recently.
The MIT License (MIT). Please see License File for more information.