Getting Started

This section walks you through everything you need to build your first Gymlium template — from setting up your development environment to validating and packaging your work.

Prerequisites

Before you begin, make sure you have:

Node.js 18+ installed (download )
Basic React / Next.js knowledge — templates are React components rendered inside a Next.js application
CSS Modules experience — all template styling uses CSS Modules (.module.css files)
A code editor — VS Code recommended, with the CSS Modules extension for autocomplete
Git — to clone the SDK repository

You do not need to know the Gymlium platform internals. The SDK provides everything you need — mock data, hooks, and a local preview server.

The workflow at a glance

Clone the SDK

Clone the sfy-pt-templates repository, which contains the scaffolding tools, validation scripts, and example templates.

Scaffold a new template

Run the scaffold command to generate a fresh template directory with all the required files and folder structure pre-configured.

Build your template

Design your Header, Footer, page layouts, and styles. Use the local dev server to preview your work with realistic mock data.

Validate

Run the validation script to check that your template meets all requirements — correct exports, required files, manifest schema, and more.

Package and upload

Zip your template directory and upload it through the Gymlium developer portal. The review team will evaluate your submission and publish it to the marketplace.

Next steps

Setting Up Your Environment — clone the SDK and scaffold your first template
Building Your First Template — a hands-on tutorial