How to

Welcome to our How to... documentation. Here, we provide a set of simple focused items that are going to give you practical information on building Genesis applications.

The How To... pages in this section point you to example applications. You can clone and run these applications, and examine the code (which includes helpful comments). Each How To page links you directly to the related repository. The README file for each example application provides a good description of the purpose of the app and the key components, and how best to navigate and understand it.

Overview of how to guides

Master the basics

These are the things that every application has to have, and basic skills to help developers building applications on the Genesis Application Platform.

Create a simple front end

See how to create a simple front end using Genesis components.

Display joined data

Join tables to create views - useful ways of looking at data. Then create queries so that these can be displayed at the front end.

Create a simple page

See how to create new pages and insert simple components.

Get to grips with Kotlin

Simple practical examples to help you master Kotlin concepts.

Enhance your application

These are common features required in many applications.

Authorize your data

Understand the principles of authorizing your users at every level.

Audit changes to a table

Make any table in your database fully audited.

Consume CSV files

Receive CSV files from an external source and update your database in the relevant way.

Send emails with attachments

Send emails with attachments easily by utilizing the notify and alerts component.

Consume a REST API

Consume data from a REST API into your application.

Consume and publish JMS

Consume from and publish to JMS queues.

Consume and publish Kafka

Connect to Kafka to consume from and publish to Kafka topics.

Add Desktop Interoperability

Use the FDC3 standard for front-end interoperability; enable your users to click between your Genesis app and other front-end applications.

Test your application

Learn how to test your application performs as you need it to.

Prepare automated tests

This page looks at the tools and the dependencies you can set up for testing.

Unit test the front end

Learn how to create unit tests for the front end of your applications.

Add end-to-end tests

Write end-to-end tests to test a full-stack application.

Run the codebases

You can clone an app in the standard way:

Follow the relevant link to the repository in the How To... page, for example Ingesting csv files.
Copy the url for the repository.
Clone the repository to a suitable working directory in your local files. For example:

C:\Users\MarcusAurelius\projects>git clone https://github.com/genesiscommunitysuccess/howto-csv-ingress.git

tip

Avoid using a network drive or a drive that synchronises with a cloud back-up system (such as OneDrive or Sharepoint). This could result in poor performance.

Once the project is cloned locally, you can run the app using Genesis Start else if you have IntelliJ on your machine, via the Genesis IntelliJ plugin

Overview of how to guides​

Master the basics​