Skip to main content

Run the demo app

Now that all the necessary components are installed for running and developing VIKTOR apps, it's time to run your first app!

App folder

We recommend creating a single folder on your hard-disk in which all your individual applications will be created (e.g. C:\Users\<username>\viktor-apps).

Right-click on the created folder and pin to "Quick Access" to enable easy navigation to this folder.

Installing the app

Open a command-line shell (Command Prompt in Windows) from within your app-folder. The easiest way to do this, is to click in the address bar, type "cmd", and hit enter:

In the command-line shell, generate the demo app using a name of you choice (e.g. "viktor-demo"):

viktor-cli create-app viktor-demo --demo

Navigate to the newly created folder:

cd viktor-demo

Execute the install command, to install the app and its dependencies:

viktor-cli install

The installation is finished when the command-line returns.


Sometimes there is some time between the command-line showing the message "Successfully installed..." and actually returning. Wait until the command-line does so. The warning about "Running pip as root..." can be ignored.

After installation, we start the app:

viktor-cli start

The CLI will establish a connection with VIKTOR and notify when ready by showing the message "App is ready". The command-line shell must be kept open to stay connected. Disconnecting from the app can be done by shutting down the running CLI process (Ctrl+C), or by closing the command-line shell.


If you encounter a "Could not authenticate" error while starting the app, please make sure that you have configured the CLI correctly.

The app is now running on the URL which is printed in the command-line shell:

  • Free users:
  • Paid users: {company} (substitute {company} with the name of your company)

Open this URL (Ctrl+click) and log in with your username and password. You will be redirected to the app's homepage.

First time

If you do not have a password, check the activation email or request a new password by clicking "Forgot Password"


If you see the "Workspaces" menu upon logging in, click the "Open" button on the "Development" workspace. After opening, you will be redirected to the app's homepage.


Click "Demo" to enter the demo editor. In the editor you can see various fields and views to showcase VIKTOR's features and functionalities. Feel free to play around.

Demo editor

Now what?

Congratulations, you have successfully installed VIKTOR and started the demo app. In the next section you will learn step-by-step how to build your first app from scratch.


Have a look into the demo app's code by opening it in your favorite IDE. The code includes plenty of examples and comments to help you understand how the app works. Feel free to copy-paste snippets from it when creating your own app.