This guide will give you a brief introduction on how to get started using Teamscale.



System Requirements

Prior to installing Teamscale, please make sure that your system meets the following requirements:



Category
Requirement
Operating System
Windows or Linux
Java

Java Runtime Environment, Version 8 or later, 64-bit

RAM
4 GB minimum
CPU

2 GHz, 2 or more cores recommended

Hard Disk

Installation: 250 MB, Data:  10 GB minimum recommended 



Download Teamscale

You can download Teamscale here.


Get a License

To use Teamscale you need a valid license file (teamscale.license). If you don't have one, you can get an evaluation license on our website. By the way: Academic users, including students and research groups, can get a free license for Teamscale. Please contact us at sales@teamscale.com for details.

If you are having troubles with your license, please contact us at support@cqse.eu.


Installation

To install Teamscale follow the steps outlined below:

  1. Unzip Teamscale from the Zip file to a directory of your choice.
  2. Place the license file into the unzipped teamscale/config directory. Note that it must be named teamscale.license
  3. Run Teamscale
    1. Windows: run the file teamscale.bat by double clicking it
    2. Linux: run the file teamscale.sh by executing ./teamscale.sh
  4. Teamscale should now be running


If you need additional information about installation and configuration options, check the administrator documentation found under documentation/admin.pdf in the Teamscale download.


First Login

After starting Teamscale open your browser and browse to http://localhost:8080. You will be greeted by a login screen:


Enter the default admin credentials:

User: admin

Password: admin


Please change this password if you are making Teamscale available to other people!


Navigating in Teamscale

At the top you will see Teamscale's main navigation bar, featuring different perspectives:

  • Dashboard: Here you can create dashboards to visualize data and result in Teamscale
  • Activity: View all commits that have been analyzed and which effect they had on the code's quality
  • Findings: View the list of all problems (called Findings in Teamscale) found in the analyzed code
  • Tasks: Manage tasks about cleaning up findings and other quality problems
  • Metrics: Browse your source code and it's relevant metrics
  • (advanced) Tests: Browse test coverage and Test Gaps
  • (advanced) Architecture: Here you can create/view specified architectures and their assessment
  • Delta: Compare two versions of your code with each other and explore the changes (metrics, findings) between those two versions
  • Project: Create/Edit projects and analysis profiles
  • System: Shows the status of the currently running analysis and displays logs and system settings
  • Admin: Manage users, groups, servers and make backups of the current configuration

First Steps - Let's add a project!

At first you want to start off by creating a new project. We will connect Teamscale to the GitHub-repository of JUnit (a java unit testing framework) as an example.

  1. Open the Projects perspective in Teamscale and click  Create new project 
  2. Enter a project name (e.g. "JUnit")
  3. Select the correct analysis profile, in this case "Java (Default)". This is the default set of analyses to run for Java systems.
  4. For Template for initial dashboard, choose Overview Dashboard. (Of course, you can also configure your own dashboards in the Dashboard perspective later)
  5. Now add a new repository using the "Add Source Code Repository" button, the choose "Git".
  6. To connect Teamscale to JUnit's GitHub repository, click the  +  button in the Account row.
    6.1 In the dialog, first enter a name Account Name (e.g. "Junit GitHub").
    6.2 Use https://github.com/junit-team/junit.git as Server URL. (The fields Username and Password can be left blank).
  7. Click OK to save this account connector. It should now be be selected in the respective dropdown.
  8. Enter a proper repository identifier (e.g. junit-git). Your overall project configuration should now look similar to this:


Now click  Create Project  at the bottom of the screen.


If the project was configured correctly, you should be redirected to the list of projects and see your new JUnit project.


When setting up your own projects, please be sure to first read section 3.1.1 Best Practices for Your First Teamscale Project in our userguide to avoid common pitfalls.


Exploring the Data

Teamscale will now start analyzing the data found in the git repository starting at the first commit. Note that it will take some time for Teamscale to analyze the entire history of the project. You can view the results by navigating to the Activity Perspective and inspecting single commits as they make their way into Teamscale. You should now be able to use most of Teamscale basic functionality. In addition, the dashboard we created during the project setup will give you a quick overview of the project's quality. But feel free to explore Teamscale on your own! 

Advanced Topics