Skip to content

Latest commit

 

History

History
60 lines (45 loc) · 3.17 KB

File metadata and controls

60 lines (45 loc) · 3.17 KB

Example(s) Directory

This directory contains example code and configuration demonstrating how to use the features and capabilities of the x0-framework / repository.

Introduction

The /example directory is designed to provide hands-on demonstrations. Each example typically includes source code, SQL scripts, and static assets to help you get started quickly.

List of Examples

Video Demonstrations

Many examples include demonstration videos in .mkv format. You can find them in each example directory or download them from the documentation links provided in each example's README.

Example Structure

Below is a schematic structure of a typical example:

├── sql/
│   ├── insert-txt.sql
│   └── sys-config.sql
├── static/
│   ├── menu.json
│   ├── object.json
│   └── skeleton.json
└── example-video.mkv

More information is available at x0-documentation Developing Examples Section.

Contributing Examples

Do you have an interesting use case? Feel free to contribute your own example! Please include a README.md in your example folder describing:

  • The purpose of the example
  • Prerequisites
  • How to run it

Thank you for helping to improve our documentation and showcase real-world usage!