Getiyo-Public/Getiyo-Developer-Documentation
1
0
Fork 0
Code Issues 6 Releases Wiki Activity

Updated specs

Mees van der Wijk
2025-08-28 00:26:25 +02:00
parent cc02426b60
commit fea0d098d1
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
V1ModuleStructure.md

@@ -1,6 +1,6 @@
# V1 Module Structure # V1 Module Structure
V1 modules represent the legacy approach to building Getiyo modules. They have several limitations: all TypeScript files are combined into a single global scope, modern JavaScript standards like import/export statements aren't supported, and there's no capability to import external Node packages. These constraints make development less efficient and maintainable. Additionally [gmt watch](./GetiyoModuleTool#watch) is not supported for V1 modules. For a significantly improved development experience with modern features, we strongly recommend using [V2 modules](./V2ModuleStructure) for all new module development. V1 modules represent the legacy approach to building Getiyo modules. They can be identified by having a `module.json` file. They have several limitations: all TypeScript files are combined into a single global scope, modern JavaScript standards like import/export statements aren't supported, and there's no capability to import external Node packages. These constraints make development less efficient and maintainable. Additionally [gmt watch](./GetiyoModuleTool#watch) is not supported for V1 modules. For a significantly improved development experience with modern features, we strongly recommend using [V2 modules](./V2ModuleStructure) for all new module development.
Each module in Getiyo comprises four key components: module.json, a server-side script, a user page, and optionally a control/external page. The detailed structure of each component is outlined below. You can automatically set up this file structure by using the [GetiyoModuleTool](./GetiyoModuleTool), as described in the ["Setting up a development environment]"(./ModuleEnvironment) section of the documentation. Each module in Getiyo comprises four key components: module.json, a server-side script, a user page, and optionally a control/external page. The detailed structure of each component is outlined below. You can automatically set up this file structure by using the [GetiyoModuleTool](./GetiyoModuleTool), as described in the ["Setting up a development environment]"(./ModuleEnvironment) section of the documentation.

2
V2ModuleStructure.md

@@ -1,6 +1,6 @@
# V2 Module Structure # V2 Module Structure
V2 modules represent the modern approach to building Getiyo modules, offering significant improvements over V1 modules. They support modern JavaScript features like import/export statements and allow the use of external Node packages, making development more efficient and maintainable. Each module comprises four key components: module.ts, a server-side script, a user page, and optionally a control/external page. The detailed structure of each component is outlined below. You can automatically set up this file structure by using the [GetiyoModuleTool](./GetiyoModuleTool), as described in the ["Setting up a development environment"](./ModuleEnvironment) section of the documentation. V2 modules represent the modern approach to building Getiyo modules, offering significant improvements over V1 modules. They can be identified by having a `module.ts` file. They support modern JavaScript features like import/export statements and allow the use of external Node packages, making development more efficient and maintainable. Each module comprises four key components: module.ts, a server-side script, a user page, and optionally a control/external page. The detailed structure of each component is outlined below. You can automatically set up this file structure by using the [GetiyoModuleTool](./GetiyoModuleTool), as described in the ["Setting up a development environment"](./ModuleEnvironment) section of the documentation.
``` ```
Module Root Module Root