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!

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 on Windows, or ~/viktor-apps on Linux).

tip

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

Installing the app

  1. Open a command-line shell (Command Prompt in Windows) from within your app folder (let's assume it's called 'viktor-apps'). On Windows, the easiest way to do this is to navigate to the folder in the file explorer, click in the address bar, type "cmd", and hit enter:

    Open a command-line shell in the 'viktor-apps' folder

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

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

    This command creates a demo app with the name 'viktor-demo'. After executing the command you will find a folder called 'viktor-demo' inside the 'viktor-apps' folder.

  3. Open PyCharm (or Visual Studio Code, or any other IDE) and open the 'viktor-demo' folder. We recommend using the terminal that is integrated in the IDE. In PyCharm the terminal window can be opened using the 'Terminal' tab at the bottom (or with Alt+F12):

    The current working directory of the integrated terminal is automatically set to the 'viktor-demo' folder.

    note

    In case you prefer to keep using the system command-line shell, navigate to the 'viktor-demo' folder manually:

    cd viktor-demo
  4. Execute the install command, to install the app and its dependencies:

    viktor-cli install

    The installation is finished when the command-line returns.

    note

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

  5. 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 simply closing the command-line shell. If you (accidentally) closed your command-line shell, just open a new one from within the app folder and restart using the start command above.

    note

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

  6. Open your app in your browser by visiting (Ctrl+click) the URL shown in the command-line shell:

    • Free users: cloud.viktor.ai
    • Paid users: {company}.viktor.ai (substitute {company} with the name of your company)
  7. 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 everything went correct, you now see the demo app's home page:

note

If you instead 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.

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.

tip

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.