This guide will give you a brief introduction on how to get started using Teamscale.
Prior to installing Teamscale, please make sure that your system meets the following requirements:
|Operating System||Windows or Linux|
Java Runtime Environment (e.g. Oracle Server JRE or OpenJDK), Version 8 or later, 64-bit, with Unlimited Strength Jurisdiction Policy (default for recent versions of Java 8)
|RAM||4 GB minimum|
2 GHz, 2 or more cores recommended
Installation: 250 MB, Data: 10 GB minimum recommended
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 email@example.com for details.
If you are having troubles with your license, please contact us at firstname.lastname@example.org.
To install Teamscale, follow the steps outlined below. For instructions on running Teamscale with Docker, please see Teamscale's Docker Hub page.
- Unzip Teamscale from the Zip file to a directory of your choice.
- Place the license file into the unzipped teamscale/config directory. Note that it must be named teamscale.license
- Run Teamscale
- Windows: run the file teamscale.bat by double clicking it
- Linux: run the file teamscale.sh by executing ./teamscale.sh
- Teamscale should now be running
If you need additional information about installation and configuration options, check the administrator documentation in chapter 5 of documentation/userguide.pdf in the Teamscale download.
Enter the default admin credentials:
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.
- Open the Projects perspective in Teamscale and click Create new project
- Enter a project name (e.g. "JUnit")
- Select the correct analysis profile, in this case "Java (Default)". This is the default set of analyses to run for Java systems.
- For Template for initial dashboard, choose Overview Dashboard. (Of course, you can also configure your own dashboards in the Dashboard perspective later)
- Now add a new repository using the "Add Source Code Repository" button, the choose "Git".
- 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).
- Click OK to save this account connector. It should now be be selected in the respective dropdown.
- 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.
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.