getting-started.rst 2.79 KB
Newer Older
1 2
.. _getting-started:

3 4 5
Getting Started
===============

Brian Douglass's avatar
Brian Douglass committed
6
* Run ``clickable create`` to get started with a new app.
7 8 9 10 11
* Choose from the list of :ref:`app templates <app-templates>`.
* Provide all the needed information about your new app.
* When the app has finished generating, enter the newly created directory containing your app.
* Run ``clickable`` to compile your app and install it on your phone.

Brian Douglass's avatar
Brian Douglass committed
12 13 14 15 16 17 18 19 20 21
Getting Logs
------------

To get logs from you app simply run `clickable logs`. This will give you output
from C++ (``QDebug() << "message"``) or from QML (``console.log("message")``)
in addition to any errors or warnings.

Running on the Desktop
----------------------

Brian Douglass's avatar
Brian Douglass committed
22
Running the app on the desktop just requires you to run ``clickable desktop``.
Brian Douglass's avatar
Brian Douglass committed
23 24 25
This is not as complete as running the app on your phone, but it can help
speed up development.

26 27 28 29 30 31 32
Accessing Your Device
---------------------

If you need to access a terminal on your Ubuntu Touch device you can use
``clickable shell`` to open up a terminal to your device from your computer.
This is a replacement for the old ``phablet-shell`` command.

33 34 35 36 37 38
Ubuntu Touch SDK Api Docs
-------------------------

For more information about the Ubuntu Touch QML or HTML SDK check out the
`docs over at UBports <https://api-docs.ubports.com>`__.

Brian Douglass's avatar
Brian Douglass committed
39 40 41 42 43 44 45 46
Run Automatic Review
--------------------

Apps submitted to the OpenStore will undergo automatic review, to test your
app before submitting it, run ``clickable review`` after you've compiled a click.
This runs the ``click-review`` command against your click within the clickable
container (no need to install it on your computer).

Brian Douglass's avatar
Brian Douglass committed
47 48
.. _publishing:

49 50 51 52 53 54
Handling dependencies
---------------------
For more information about compiling, using and deploying app dependencies, check out the
`docs over at UBports <https://docs.ubports.com/en/latest/appdev/guides/dependencies.html>`__.


Brian Douglass's avatar
Brian Douglass committed
55
Publishing to the OpenStore
56 57
---------------------------

Brian Douglass's avatar
Brian Douglass committed
58 59 60 61
If this is your first time publishing to the OpenStore, you need to
`signup for an account <https://open-store.io/login>`__. You can signup with
your GitHub, GitLab, or Ubuntu account.

Brian Douglass's avatar
Brian Douglass committed
62 63
If your app is new to the OpenStore you must first create your app by entering
the name from your manifest.json and the app's title
Brian Douglass's avatar
Brian Douglass committed
64 65 66 67 68 69 70 71 72 73
on the `OpenStore's submission page <https://open-store.io/submit>`__.

If your app already exists you can use the ``clickable publish`` command to
upload your compiled click file to the OpenStore. In order to publish to the
OpenStore you need to grab your
`api key from the OpenStore <https://open-store.io/manage>`__. After you have
your api key you need to let Clickable know about it. You can either pass it
as an argument every time: ``clickable publish --apikey XYZ`` Or you can set it
as an environment variable: ``export OPENSTORE_API_KEY=XYZ`` (you can add this
to your ``~/.bashrc`` to keep it set).