Documentation/Creating Realms/Publishing

Publishing Guide

Share your realm templates with the community. Learn how to prepare, validate, and publish high-quality realms to the RealmKit Hub.

Why Publish Your Realm?

Benefits of sharing your templates with the community

Build Reputation

Gain recognition in the developer community for your high-quality templates

Help Others

Speed up development for thousands of developers using your templates

Get Feedback

Receive valuable feedback and contributions to improve your work

Publishing Process

1
Prepare Your Realm
15-30 minutes

Ensure your realm is complete and well-documented

Tasks

Complete realm.yml configuration
Add comprehensive AI context documentation
Test the realm creation process
Verify all features work correctly
Include clear README with setup instructions

Validation

realmkit validate

2
Review Requirements
10 minutes

Check that your realm meets publishing standards

Tasks

Minimum 3 files in the project
Valid realm.yml with required fields
Working package.json or equivalent
At least basic AI context documentation
No sensitive data or credentials

Validation

realmkit publish --dry-run

3
Configure Publishing
5 minutes

Set up authentication and publishing options

Tasks

Authenticate with RealmKit Hub
Choose visibility (public/private)
Set category and tags
Configure licensing
Review publishing agreement

Validation

realmkit auth status

4
Publish Realm
2-5 minutes

Submit your realm to the hub

Tasks

Run publish command
Monitor upload progress
Verify realm appears in hub
Test installation from hub
Share with community

Validation

realmkit info <your-realm-name>

Quality Checklist

Ensure your realm meets high standards before publishing

Documentation

Clear project description and purpose
Complete setup instructions
AI context files with good coverage
Feature documentation
Contributing guidelines
License information

Code Quality

Clean, readable code
Consistent formatting
No hardcoded secrets
Error handling
Basic tests included
Dependencies are current

Functionality

Project builds successfully
All features work as documented
No broken links or imports
Environment setup is complete
Database migrations work
Development server starts

User Experience

Easy to understand and follow
Good default configuration
Helpful error messages
Examples and demos included
Mobile-responsive if applicable
Accessible design patterns

Visibility Settings

Choose who can discover and use your realm

Public

Available to all users, appears in search results

Features

• Listed in browse page
• Searchable
• Analytics provided
• Community ratings

Recommended For

Open source projects, educational templates

Unlisted

Only accessible via direct link

Features

• Not in search results
• Share via URL
• Limited analytics
• No public ratings

Recommended For

Work in progress, client projects

Private

Premium

Only you and invited collaborators can access

Features

• Complete privacy
• Invite-only access
• Full control
• Premium feature

Recommended For

Proprietary templates, internal tools

Publishing Commands

Essential CLI commands for realm publishing

realmkit auth login

Authenticate with RealmKit Hub

realmkit auth login --provider github

realmkit validate

Check realm for publishing requirements

realmkit validate --strict

realmkit publish

Publish realm to the hub

realmkit publish --category saas --tags "nextjs,typescript"

realmkit update

Update an existing published realm

realmkit update --version 1.1.0

realmkit unpublish

Remove realm from the hub

realmkit unpublish my-realm-name

Complete Publishing Workflow

Step-by-step commands to publish your realm

# 1. Authenticate with RealmKit Hub
realmkit auth login

# 2. Validate your realm
realmkit validate --strict

# 3. Test creation process
realmkit create . test-project

# 4. Publish to hub
realmkit publish \
  --category "saas" \
  --tags "nextjs,typescript,prisma" \
  --visibility "public" \
  --license "MIT"

# 5. Verify publication
realmkit info my-realm-name

# 6. Test installation
realmkit create my-realm-name test-install