Skip to main content

Introduction

Introduction#

The whole chapter "Training for programmers" is about to give you some examples, tutorials, and how to create models programmatically with the Solid and History API. To provide easy access to this whole topic, we implemented a simple application with many examples. The application can be found on GitHub, and it's called buerli-examples. For a brief introduction see the Examples page.

Besides a lot of different examples which cover more or less all possibilities we can implement with our APIs, there are also empty templates that can be used to create your samples. Furthermore, we also created folders called "Tutorials", which provide for each of our API's tutorials to go through the first steps and learn how to work with them.

Buerli-examples is just a proposal of how users could create an application. In the end, it's entirely up to them how they want to implement an application using our APIs. It's escpecially implemented to give the users an idea to see what can be done with headless programming and how you can create such examples/models. Furthermore, it should be a playground for implementing first ideas.

Add your own examples to buerli-examples application#

In the following chapters, we will guide you through some tutorials. You will create samples by copying a template and adding your code. To see your examples in the application, you must add them to the store.ts file in the "src" folder. In general, the steps are the following:

  1. Copy the template you were prompted to in the tutorials
  2. Give the file your name and keep it in the same folder as the template
  3. Add your code or the code you will find in the tutorials to the file
  4. Add the example to the store.ts file; see the following snippet.
{ exampleId: 'Felge', label: 'Felge', file: 'solid/felge' },
{ exampleId: 'Wall', label: 'Wall Configurator', file: 'history/SwissProperty' },
{ exampleId: '<Your unique id>', label: '<name of the example>', file: '<path of the file>' }

If you do these steps right, your example will be available in the list with the label you defined and the API you have chosen (Solid or History).