All the badges are tested against app inside the ElectronClient

Electron Client for Servoy

This client is made as replacement of the Servoy Smart Client.

Two issues with the Servoy Smart Client:

1. The Smart Client is based on Java Swing technology, which does not provide the features to build a modern UI/UX.
2. The Smart Client relies on Java, this dependency causes maintenance work, especially around code signing and security caused by new Java releases.

Therefore, the Servoy Electron Client has a modern UI/UX and has the the possibility of using the Servoy NG-Client with access to the local functionalities of the operating system.

Table of Contents

• Setup
  • Prerequisites
• Usage
  • Creating the executable
    • Apache Ant
    • Loading your solution
    • Changing app icon
    • packaging the application
    • How is the packaging done?
• Creation of features
• License

Setup

The setup for further local development of the Servoy Electron Client.

Prerequisites

Make sure you have Node.js, Python 2.x and the Servoy Developer installed on your system. Windows users will also require Visual Studio

Python

Node.js >= 7

Servoy Developer

Visual Studio

For further development of Microsoft Office integration

Please send an email to dhaneveld@servoy.com to get the .NET project and information on how you can further improve it.

Usage

Built With

Node.js, JavaScript and .NET

Creating the executable

For creating an executable on your local machine for local development you have to do the following:

Apache Ant

The process of creating an executable is done with Apache Ant. For MacOS I recommend installing Apache Ant with Homebrew.

This project consists of an build.xml file where you can edit the settings of creating an executable.

Loading your solution

To load in your solution made with the Servoy Developer there are several things to do:

1. Check your local IP address

   • On Windows open up a command prompt and type ipconfig.
   • On Mac and Linux open up a terminal and type ifconfig.

2. Now head over to the build.xml

   • Replace the value of the property url with the url of your application
   • Example: http://192.168.43.197:8080/solutions/ElectronSample/index.html?f=Main

3. Don't have a solution or electron web package?

   • import the ServoyExample and the electron web package from this repository.

Changing app icon

If you wish to change the icon for your local development installation you have to do the following:

• Navigate to electron/ElectronClient/app/resources/icons/ | add your icon here.
• Navigate to electron/ElectronClient/app/config/servoy.json | replace with the name of your icon

packaging the application

First you can choose for what platform and arch type you want to create your application. Navigate to the build.xml and do the following:

• Replace the value of the property platform with the following options: --platform windows, --platform darwin, --platform linux
• Replace the value of the property arch with the following options: --arch=x64, --arch=ia32

run the following command in your command prompt or terminal to package the application:

ant run.electron

How is the packaging done?

To package the application a CLI program is included inside the ElectronClient.

It resides inside electron/ElectronClient/lib and has the following architecture:

Creation of features

To create new features for the Client there is a tutorial on explaining how you can do this. You can find the tutorial inside the wiki with the following link:

Creating features for the Servoy Electron Client

Furthermore, to get a clear understanding of how the processes in Electron work, you can look up the other pages inside the wiki.

License

This project is licensed under the MIT License - see the LICENSE.md file for details