LogoLogo
Developer HubGitHubContact Us
  • Welcome!
  • Olive Helps
    • Platform
      • How Olive Helps Works
      • Installation
      • Account Creation
      • Distributing Olive Helps
    • FAQs
      • General Loop FAQs
      • Loop Development FAQs
      • Olive Helps User FAQs
      • Security / IT FAQs
    • Data Security
      • User Data
      • Antivirus and Firewalls
  • Loop Development Kit
    • Your First Loop
      • Become a Loop Author
      • Creating a Loop
      • Build Your Loop
      • Local Loop Installation
      • Restarting Local Loops
    • Troubleshooting
    • Loop Security
      • Permissions
      • Environment Permissions
    • Loop Publication
      • Loop Approval Checklist
    • Loop Analytics Library
    • Examples
  • Documentation
  • Interfaces
  • Type Alias
  • Enumerations
  • Whisper Components
    • Base Attributes
    • Autocomplete
    • Box
    • Breadcrumb
    • Button
    • Chart
    • CollapseBox
    • Grid
    • Checkbox
    • Date Time
    • Divider
    • DropZone
    • Email
    • Icon
    • List Pair
    • Link
    • Pagination
    • Number
    • Markdown
    • Message
    • Password
    • Progress
    • Radio
    • Rating
    • RichTextEditor
    • Section Title
    • Select
    • Text Input
    • Telephone
    • Typography
  • APTITUDES
    • What are Aptitudes?
    • Browser
    • Clipboard
    • Config
    • Cursor
      • Screen Scaling Behavior
    • Document
    • Filesystem
    • Keyboard
    • Network
    • Process
    • Screen
    • Search
      • Index
    • System
    • UI
      • Loop UI Handlers
    • User
      • JWT
    • Vault
    • Whisper
      • Whisper Updates
      • JSX Whispers
    • Window
      • Screen Scaling Behavior
  • Release Notes
    • What's New
      • Olive Helps v0.55.0
      • Olive Helps v0.54.1
      • Olive Helps v0.53.1
      • Olive Helps v0.51.2
      • LDK v4.0.0
      • Olive Helps v0.50.3
      • Olive Helps v0.49.5
      • LDK v 3.18.0
      • Olive Helps v0.47.2
      • Olive Helps v0.46.2
      • LDK v 3.17.0
      • Olive Helps v0.45.4
      • Olive Helps v0.44.2
      • Olive Helps v0.43.1
      • Olive Helps v0.42.1
      • Olive Helps v0.41.4
      • Olive Helps v0.40.2
      • Olive Helps v0.39.4 & LDK v3.16.0
      • Olive Helps v0.38.8 & LDK v3.15.0
      • Olive Helps v0.36.5
      • Olive Helps v0.36.4
    • Archive
      • Olive Helps v0.36.3 & LDK v3.14.0
      • Olive Helps v0.34.4
      • LDK v3.13.0
      • Olive Helps v0.32.2 & LDK v3.12.0
      • Olive Helps v0.31.2 & LDK v3.11.0
      • Olive Helps v0.30.2 & LDK v3.10.0
      • Olive Helps v0.29.4
      • Olive Helps v0.29.3 & LDK v3.9.0
      • Olive Helps v0.28.3 & LDK v3.8.0
      • Olive Helps v0.27.7
      • Olive Helps v0.27.5
      • Olive Helps v.027.4
      • Olive Helps v0.27.2 & LDK v3.7.0
      • Olive Helps v0.25.3 & LDK v3.5.1
      • Olive Helps v0.24.6 & LDK v3.4.0
      • Olive Helps v0.23.2 & LDK v3.3.0
      • Olive Helps v0.22.3 & LDK v3.2.0
Powered by GitBook
On this page
  • Environment
  • Building the Loop
  • Manual Builds
  • Automatic Builds

Was this helpful?

  1. Loop Development Kit
  2. Your First Loop

Build Your Loop

Once you have your Loop created (even if it is just the sample code), you will need to build the Loop out -- here are some steps to help.

PreviousCreating a LoopNextLocal Loop Installation

Last updated 3 years ago

Was this helpful?

Environment

Install , or install/use a version manager like . (We recommend using the current LTS version (at the time of writing, that is some flavor of v14).

Open PowerShell or a Terminal (or any other prompt of choice). Double check your installation of Node.js by typing:

node -v

If the command returns a version, Node.js is properly working. Next, you will need to install npm. Run the following:

npm install -g npm

To check your installation run:

npm -v

If the command returns a version, npm is properly installed, and you are ready to move on.

Building the Loop

Manual Builds

Navigate to your Loop directory within the open prompt:

cd $PROJECT_LOCATION

In order for your Loop to work correctly, you now need to install its dependencies:

npm install

Let the installer finish -- this may take several minutes. Next, you will need to build your project:

npm run build

This command will be used often -- to save time, push the up arrow while in your prompt to see and use previous commands.

This will create a loop.js file in the dist folder of your project. This is the main file needed to use your Loop locally.

Every time your code changes, you will need to rebuild your Loop. You will then need to restart it from the Loop Library.

Automatic Builds

It might be beneficial or easier if your loop.js file were automatically built any time you save changes to your Loop's code. The main situation for this is to be used in tandem with Live Reloading.

In order to do this, you need to add a new item to the "scripts" section in your Loop's package.json. An example of what the new script could look like is this:

{
  ...
  "scripts": {
    ...
    "dev": "webpack --watch",
    ...
  },
  ...
}  

Moving forward, you could run the following command (rather than npm run build):

npm run dev

At this point, any time you save a file in your Loop project, Webpack will automatically detect it and rebuild the loop.js file.

Our suggested option for building the loop.js file automatically is to use a specific Webpack "watch" command. An alternative, which we won't dive into, is using .

Node.js
NVM
Nodemon