Getting started

Make sure that you have the following installed and ready:

Checkout the Drone App boilerplate


Before we start, make sure you're logged in with your ViewAR Account because this is where your app will be linked to. The registration is easy and free.

As soon as you're registered, into your terminal/command prompt go for:

viewar login

Now, create a directory and initialize a new project inside it:

viewar init directoryName

Choose your user from the list displayed.

Select the user account for this app. Navigate through the list with the up/down arrow keys. 
❯ userName <>

Initialize the boilerplate app

Now, the CLI will ask a couple of questions to configure an app for you. Go with the following settings:

-> Select a project type:
   > Project: Sample Project/Template
-> Select a template project:
   > Other…
-> Repository URL:
-> Enter the App ID: // Pick a name you prefer
   > drone.controls.v01
-> Enter the App Version: // continue by pressing enter or set the version manually
   > 1.0

What is going on under the hood?

A new JavaScript project has just got initialized, containing:

  • srcdirectory with:
    • index.htmland index.js ( + some additional files imported from the index.js)
    • additional resources you'll need later:
      • joysticks component
      • math
  • config files:
    • common config files like package.json,
    • viewAR-specific config files, e.g.:
      • .viewar-config - containing the app-specific and deployment information (e.g. AppID, deployment token)

See the app running

Working version
Web version

You may now switch into the directory and start the development server in the mock mode:

cd directoryName
npm run start:mock

Since we are building an AR application, it is important for this example that you started the mocked server. Otherwise the web 3D engine would be started, which would collide with the 3D engine on a phone.

Mobile device

First, make sure that your phone and computer are in the same local network.

Next start the ViewAR SDK app, switch to LAN Development Mode and fill the fields with:

  1. Your App ID
  2. App Version - may be empty
  3. IP and port of your mocked server
Deployed version

The last deployed version (in this case - the original boilerplate version, since you haven't made any improvements yet), should already be available online! Start the ViewAR SDK App on you mobile device, turn off the LAN mode and fill in the fileds with:

  1. Your App ID
  2. App Version (leaving this field empty will result in the app using the default setting: <=100)

Screenshot from the Drone Control Boilerplate App

Try removing the "Hello World." message and seeing the changes on your mobile device in the LAN mode before going further.

// Remove this whole part
const Hello = () => (
  <div className={styles.Hint}>Hello world.</div>

Remember to remove both the definition and the rendering.

  // Render jsx.
  return (
      <Hello /> // Remove me!

      <div className={styles.LeftJoystick}>
        <Joystick onChange={handleLeftJoystickInput} />

< Previous StepNext Step >

Useful reads:

> ViewAR CLI > Mobile Device > ViewAR Developer Account