Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Steema/TeeChart-VCL-GitHub-Contributions/llms.txt

Use this file to discover all available pages before exploring further.

​
Required Tools

To develop the GitHub Contributions Chart application, you’ll need:

Delphi/C++Builder

Embarcadero Delphi or C++Builder (XE7 or later recommended)

TeeChart VCL

TeeChart VCL library for chart visualization
  • Delphi 10.4 Sydney or later (for best compatibility)
  • C++Builder 10.4 or later (if using C++ development)
  • Earlier versions (XE7+) may work but are not tested

​
TeeChart VCL Installation

The application relies heavily on TeeChart VCL components for visualizing the contribution graph.
1

Install TeeChart VCL

TeeChart VCL is included with Delphi/C++Builder Professional and Enterprise editions. If you have a Community Edition, you’ll need to purchase or evaluate TeeChart separately from Steema Software.
2

Verify Installation

Open the Delphi IDE and check that the TeeChart components are available in the Tool Palette under the “TeeChart” tab.
3

Configure Component Path

Ensure the TeeChart library path is included in your project’s search path:
  • Open Tools > Options > Language > Delphi > Library
  • Verify TeeChart paths are listed in the Library Path

​
Project Structure

The project follows a standard Delphi VCL application structure: 
workspace/source/
├── GitHubContributions.dpr    # Main program file (entry point)
├── Unit1.pas                  # Main form unit with core logic
├── Unit1.dfm                  # Form definition (visual design)
└── Themes.pas                 # Theme definitions and color schemes

​
File Descriptions

The main program file that initializes the VCL application and creates the main form.
program GitHubContributions;

uses
  Vcl.Forms,
  Unit1 in 'Unit1.pas' {Form1},
  Themes in 'Themes.pas';

begin
  Application.Initialize;
  Application.MainFormOnTaskbar := True;
  Application.CreateForm(TForm1, Form1);
  Application.Run;
end.
Contains the main form class TForm1 and all application logic including:
  • GitHub API integration
  • Chart rendering logic
  • Event handlers for user interactions
  • Date/week calculations
Defines the TTheme record type and provides two built-in themes:
  • StandardTheme - Light theme with GitHub’s standard colors
  • GithubDarkTheme - Dark theme matching GitHub’s dark mode
Form definition file containing visual component properties and layout. This is automatically maintained by the Delphi IDE’s form designer.

​
Dependencies

The project uses the following Delphi/VCL units:

​
Windows & System Units

Winapi.Windows
Winapi.Messages
System.SysUtils
System.Variants
System.Classes
System.Rtti
System.Generics.Collections
DateUtils

​
VCL Components

Vcl.Graphics
Vcl.Controls
Vcl.Forms
Vcl.Dialogs
Vcl.StdCtrls
Vcl.ExtCtrls

​
Network Components

System.Net.HttpClient
System.Net.HttpClientComponent

​
JSON Processing

System.JSON
System.JSON.Readers
System.JSON.Types
System.JSON.Builders

​
TeeChart Components

VCLTee.TeEngine    # Core TeeChart engine
VCLTee.TeeProcs    # TeeChart procedures
VCLTee.Chart       # Chart component
VCLTee.TeeSurfa    # Surface series
VCLTee.Series      # Series types
VCLTee.TeeTools    # Chart tools (annotations, tips)

​
Custom Units

Themes  # Application theme definitions

​
Opening and Building the Project

1

Open the Project

Launch Delphi and open GitHubContributions.dpr from the source directory.
2

Verify Dependencies

Ensure all units in the uses clauses can be found. The IDE will highlight any missing units in red.
3

Build the Project

Select Project > Build GitHubContributions or press Shift+F9.
The first build may take longer as the compiler processes all TeeChart units.
4

Run the Application

Press F9 to run the application in debug mode, or Ctrl+Shift+F9 to run without debugging.

​
Configuration Requirements

​
Internet Access

The application requires internet access to:
  • Fetch GitHub contribution data from github-contributions.vercel.app
  • No authentication is required for the API

​
System Requirements

  • OS: Windows 7 or later
  • RAM: 2GB minimum (4GB recommended)
  • Disk Space: 100MB for compiled application
Ensure your firewall allows the application to make outbound HTTP requests to github-contributions.vercel.app.

​
Troubleshooting

Problem: Build fails with errors about missing TeeChart units.Solution:
  1. Verify TeeChart is properly installed
  2. Check that TeeChart library paths are in Tools > Options > Library Path
  3. Try reinstalling TeeChart from the GetIt Package Manager
Problem: Application cannot fetch GitHub data.Solution:
  1. Check your internet connection
  2. Verify firewall settings allow HTTP requests
  3. Test the API directly: https://github-contributions.vercel.app/api/v1/sallar
Problem: Application crashes when processing GitHub data.Solution:
  1. Ensure you’re using Delphi XE7 or later (required for modern JSON support)
  2. Check that System.JSON units are properly included
  3. Verify the API response format hasn’t changed

​
Next Steps

Code Structure

Learn about the application architecture and key procedures

API Reference

Explore the complete API documentation for all functions

Build docs developers (and LLMs) love

Get started for freeTalk to us