Please check OS specific requirements below.
By default the app builds for testing server. To use the compiled app with live server see this guide https://github.com/toggl/toggldesktop/wiki/Building-Toggl-Desktop-from-source-for-usage-with-live-servers
First, build dependencies:
make deps
then the app itself:
make
To build, then run the app:
make run
Run unit tests with
make test
and UI tests with
make uitest
You'll need these Qt (at version 5.12 or higher) modules: QtWidgets (with private headers), QtWebEngine, QtWebEngineWidgets, QtNetwork, QtDBus, QtX11Extras
If Qt is not installed from your distribution's package manager, you will need to set the CMAKE_PREFIX_PATH
environment variable to point to the lib/cmake
folder in the Qt version you wish to use.
These dependencies are mandatory:
- libXScrnSaver (
libxss-dev
in deb-based distros andlibXScrnSaver-devel
in rpm-based)
You can install them all in debian with a command:
sudo apt install libxss-dev build-essential libgl-dev libreadline-dev
These dependencies are optional and will be bundled if the USE_BUNDLED_LIBRARIES
CMake argument is set or your system does NOT have their development packages installed:
- POCO
- Lua
- jsoncpp
- Qxt
These libraries will be bundled regardless of your system:
- bugsnag-qt
- qt-oauth-lib
in the toggldesktop source tree root
mkdir -p build && pushd build # Create build directory
cmake .. # Setup cmake configs
make -j8 # Build the app. The number defines the count of parallel jobs (number of your CPU cores is a good value for that)
./src/ui/linux/TogglDesktop/TogglDesktop # Run the built app
Install Visual Studio 2019 with .NET desktop development
, Desktop development with C++
and Universal Windows Platform development
components checked during installation. You can download free Visual Studio Community here.
The solution is using OpenSSL binaries. To rebuild OpenSSL from sources refer to this page.
Toggl built and signed app for macOS is available for download. Officially macOS 10.11 and newer stable macOS versions are supported.
Toggl built and signed app for Windows is available for download. App has been tested on Windows 7, 8, 8.1 and 10.
Toggl Desktop Windows app has not been tested on Surface type touchscreen environments.
Change log can be viewed at http://toggl.github.io/toggldesktop/
The documentation of the code base is currently work in progress and can be found at /docs/.
Before sending us a pull request, please format the source code:
make fmt
Also, please check for any cpplint issues:
make lint
Check if unit tests continue to pass:
make test