Quick Start

Installation

To use the admin we first need to install it as part of our environment.

1
2
3
git clone https://github.com/Luxoft/qml-coreui.git
cd qml-coreui
pip install .

Setting up QtAuto Stack

The simplest start is to use an existing Qt SDK (e.g. 5.13 incl. Qt Remote Objects TP) and build of QtAuto components. This is a great start to the creation of a new user interface for systems.

Create a project directory

1
mkdir coreui && cd coreui

Write the config file coreui.yml

1
coreui-admin init

Configure qmake to use existing Qt5 SDK

1
coreui-admin config qmake <path/to/qmake>

Clone QtAuto source repositories

1
coreui-admin clone auto

Build all QtAuto repositories

1
coreui-admin build auto

Note: Please make sure that all coreui components are successfully configured.

Now we can start the QtAuto reference user interface called Neptune3 UI.

1
coreui-admin start

The script was automatically registered while building the QtAuto repositories.

Setting up a new CoreUI project

Now we can create the single-process UI

1
2
coreui-admin new myproject
cd myproject

We first let the admin know where the existing Qt SDK is located. For this, we point it to the qmake executable for the SDK.

1
coreui-admin config qmake <path/to/qmake>

We can launch the UI using the start script, which was registered by the project generator.

1
coreui-admin start

To develop with the newly created UI you can open QtCreator and open the myproject/myproject.qmlproject project.