- Introduction
- venue.json
- thumbnail.png
- global
- global/experiences
- global/partials
- global/assets
- LivePage Templates
- login
- 404
Introduction
The following folder structure shows the minimum files and folders required for a venue. In the example below, the venue consists of 1 template and 1 experience only. The files and folders in red are required for all venues, while the rest are optional.
venue
βββ thumbnail.png
βββ venue.json
βββ global
βΒ Β βββ assets
βΒ Β βΒ Β βββ sample.jpg
βΒ Β βββ experiences
βΒ Β βΒ Β βββ experience1
βΒ Β βΒ Β Β Β βββ experience.json
βΒ Β βΒ Β Β Β βββ screenshot_1.png
βΒ Β βΒ Β Β Β βββ screenshot_2.png
βΒ Β βΒ Β Β Β βββ screenshot_3.png
βΒ Β βββ partials
βββ template1
βΒ Β βββ index.html
βΒ Β βββ template.json
βββ login
βΒ Β βββ index.html
βΒ Β βββ template.json
βββ 404
Β Β βββ index.html
Β Β βββ template.json
venue.json
venue.json contains the metadata of the venue and is documented here: venue.json
thumbnail.png
The thumbnail image file at the root level is used when listing the venue in the . The specs of the file should be as follows:
Filename: thumbnail.png
Size: 270 x 180px
global
The global folder is a required folder that you can use to store common/shared files. These files are accessible to all templates within a venue. The files inside the global folder can be accessed via Rebar Merge Tag, as shown below:
<script src="{{global.baseUrl}}/scripts/jquery.js"></script>
<link rel="stylesheet" href="{{global.baseUrl}}/styles/header.css" />
<img src="{{global.baseUrl}}/assets/background.png" />
You can also access the contents of the global folder in Javascript code:
document.getElementById(βmy-imageβ).src =
`${window.GEVME.global.baseUrl}/assets/background.png`;
global/experiences
A venue should have at least 1 experience defined.
A venue can have as many experiences as needed. Each experience is represented by a folder under the experiences folder (found under global folder).
Read more about the files requirements and JSON config file at: Experiences
global/partials
Partials is a feature of Rebar Language. Partials allows you to create shared HTML codes that can be used by multiple files across multiple templates. .
For example, if you want to create a header or a footer and reuse it across templates, or simply break a large html file into smaller chunks, you can take advantage of partials.
For example, if you create a file calledΒ header.html
Β inside the partials folder of a template, you can access it with the following Rebar Merge Tag: {{{global.partials.header}}}
.
global/assets
This is an optional folder where you can centrally store all your assets. Once you store a file within the global folder, it is accessible through at this path: {{global.baseUrl}}
.
In the example above, the file sample.jpg can be accessed in templates at: {{global.baseUrl}}/assets/sample.jpg
LivePage Templates
A LivePage Template is stored in a folder at the root level of the venue repository. As such every folder that is created at the root level (apart from global
) is considered to be a template folder.
Read more about the files configurations and requirements at: LivePage Templates
login
The login page for an event is determined by the login template. This is a reserved template name and is used whenever the login screen needs to be shown.
404
This is another reserved template name. It is used whenever a Page Not Found error happens and a 404 page is shown.