Getting started

Make sure you have met the requirements before getting started.

This chapter describes the development experience for creating a new instance of FontoXML Content Quality App.

The self-contained builds for FontoXML Content Quality App are not yet supported by FontoXML Development Tools (FDT). We recommend you use the Docker images or contact us for more information if you want to run the self-contained build.

1) New project

Create a new project using FDT by executing the following command:

Shell

fdt fcq init --version <version>

FDT has created a file and folder based structure on your local machine as follows:

  • .env

  • Configuration/analysis.xml

The analaysis.xml file contains an example analysis configuration.

fdt fcq init also creates a .fontoxmlFcqManifest file. This file should not be modified.

2) Configuration

After setting up a new project, it is time to configure the app, analysis and editor.Please follow the Configuration documentation for in-depth instructions.

3) Test run

This step requires you to be logged into our Docker repository. See the requirements for more information.

You are now done configuring the FontoXML Content Quality App instance and ready to do a test run.

Execute the following command inside your working directory to get your project up and running. This command will build your image and runs it inside a Docker container. The container is cleaned up after you press Ctrl-C to stop the application.

Shell

fdt fcq run

While running your FontoXML Content Quality App instance, start the local FontoXML Editor development server to test your app instance.

Open up a browser and visit the URL of the local development server and test the FontoXML Content Quality App integration.