This page explains how to configure, create, run and use the GEARS generated application, which is the combination of the specifically GEARS generated functionality + the generic functionality called the GEARS runtime.

• 1. Table of content
• 2. How to get started
• 3. How to configure GEARS and the generated application
• 4. How to generate, build and start the application
• 5. Need a mail server for testing?
  • 5.1. hMailserver (Windows only)
  • 5.2. Mail server from Docker
  • 5.3. Configure mail client to receive the mails

When you are new to using GEARS you first need to get started. This is described in GS_00_Get_started_with_GEARS. There you will learn how to arrange pre-requisites, setup your first project and develop software using GEARS.

This is described in Configure GEARS generator.

Start it from VS Code, that has the GEARS Language Support extension installed. Press CTRL+SHIFT+B and choose

1. GEARS: .. Generate: if you have not already generated the designs and source code for your GEARS application
2. GEARS: .. Build: if you have not already compiled the generated sources and the runtime to a working application.
3. GEARS: .. Run application. This will start the working application. The terminal window in VS Code will show the log of runtime. Once it says something like Started <name of your application> in <nr of> seconds you application is running.
4. GEARS: .. Load data: load any data. Most applications require this to work properly.
5. GEARS: .. Run scenarios: run your test scenario's.

When you want to test mail functionality, you can either look in the SYS_MAIL table to find the mail that was send by your application. If you have configured your application to actually send mail you need a mail server. We provide 2 options for that hMailServer and a preconfigured Docker image.

On Windows the best option is probably hMailServer. These are the steps required to make it work:

1. Press the Windows Key, type in Turn Windows Feature on and of and then turn on .NET Framework 3.5....
2. Download and install hMailServer.
3. Open the application hMailServer Administrator.
4. Click Connect.
5. Under Domains add a new domain xlrit.local.
6. Under xlrit.local click Accounts and add a new account [email protected] with password all.
7. Click domain xlrit.local. Under Advanced enter [email protected] as the Catch-all address email address.
8. Under Settings > Advanced > TCP/IP ports > ...POP3 change TCP/IP port to 1110.
9. Under the last Settings > Advanced > TCP/IP ports > ...25 / SMTP change the TCP/IP port to 2525.
10. Optionally under Status you can check if the server is running, you can Pause or Resume it and under Logging you can view, Start and Stop logging.

On Linux or Mac the easiest solution would be to use our preconfigured mail server. It already has [email protected] configured as the catch all email address.

1. Download and install Docker.
2. Install the VS Code extension Docker (by Microsoft)
3. Create the following docker-compose.yml file:

version: '3'
services:
  runtime:
    image: "xlrit/mailserver"
    container_name: "gears-mailserver"
    ports:
      - "1110:110"
      - "2525:25"

4. right click on that file and choose Compose Up:

You should be able to use any mail client but we prefer Thunderbird (because it nags the least about connecting to a locally running mail server). No matter which client the basic configuration of should be the following: