Skip to main content
Version: v5.2

Making script changes to your local app

The scripts and setupScripts folders contain all the scripts and other files required for a local project setup and the operations of the app. You can edit these scripts and test the results in a project setup via a browser pointing to a local host or via the VS code plugin setup, which is a manual process. For the local browser setup, these scripts are served from the locally run server but you need to expose them using a cloudflare tunnel with the following steps:

Pre-requisite: To install the tunnel client, run brew install cloudflared.

  1. Open a terminal and run cloudflared tunnel --url http://localhost:8086. Wait for it to print a URL with the following format and copy it: https://<random-words>.trycloudflare.com.
  2. Go to app/public/config.js.
  3. For the setupZipFileOrigin property value, replace https://<domain>.trycloudflare.com with https://<your-random-words>.trycloudflare.com so that the value reads https://<your-random-words>.trycloudflare.com/reference/project_setup/setupScripts.zip.
  4. For the projectZipFileOrigin property value, replace https://<domain>.trycloudflare.com with https://<your-random-words>.trycloudflare.com so that the value reads https://<your-random-words>.trycloudflare.com/reference/project_setup/data.zip.
  5. To stage the scripts, run npm run pushScripts.
  6. To start the local server, run npm run watch.
  7. Open a browser in private browsing mode to http://localhost:8086/reference,then log in and create a project.

Note: Changes you make to the scripts in your IDE and push in the above procedure are in effect when the resources are created. If you want to alter scripts that have already been created in the database under the project's namespace, you can update them via the REST API or the Console App.