Skip to main content

Getting Started with App Development

Building and publishing an app on the epilot platform follows a straightforward process designed to help you move efficiently from initial setup to marketplace presence. This guide outlines the core steps you'll take on your journey to becoming an epilot app developer.

The App Development Journey​

flowchart LR A[Request Developer Account] --> B[Build Private App] B --> C[Request Review] C --> D[Beta Release]

1. Request Developer Account​

Your first step is to obtain a dedicated developer sandbox account:

  • Visit the developer sandbox section to learn about sandbox accounts
  • Provide details about your organization and development plans
  • Once approved, you'll receive credentials for your sandbox environment
  • This isolated account provides a safe space to experiment with epilot's features

2. Build Your First Private App​

Getting started is as simple as:

npx epilot app init my-app

This creates a local monorepo with an empty manifest.json — the declarative source of truth for your entire app. The manifest describes your app's metadata, components, permissions, and assets.

From there, use the CLI to add and remove components:

cd my-app

# Add a component (interactive type selector, or pass --type)
epilot app add-component my-block --type CUSTOM_JOURNEY_BLOCK

# Remove a component
epilot app remove-component my-block

Each CLI command updates the manifest.json automatically. You develop your components locally, and when you're ready:

# Build all components
npm run build

# Deploy — creates or updates the app on the epilot platform
epilot app deploy

epilot app deploy reads your manifest and syncs everything to the platform: it creates the app on first deploy, uploads component bundles, and keeps the remote state in sync with your local manifest.

See the CLI documentation for the full command reference, and the app-templates repository for starter templates for each component type.

Building with AI coding agents

Every scaffolded app includes a SKILL.md file — a structured guide that teaches AI coding agents (like Claude Code, Cursor, or GitHub Copilot) how to work with the epilot app manifest, component types, and CLI commands. This makes it significantly faster to build, configure, and iterate on your app with AI assistance.

You can also build your app through the UI at https://portal.epilot.cloud/app/apps/configuration/new.

info

During this phase, your app remains private and is only visible within your organization. Take advantage of this isolation to perfect your app's functionality.

3. Request Review​

When your app is ready for the spotlight:

  • Ensure your app documentation is complete
  • Verify all components function as expected
  • Navigate to the version management section of your app
  • Select the version you want to publish
  • Click "Request Review" to submit for evaluation
  • Our team will assess your app against quality and security standards
  • You'll receive feedback if any improvements are needed

The review process helps maintain high standards in the epilot marketplace and ensures all apps provide value to users.

4. First Public Version: Beta Release​

Upon approval of your review request:

  • Your app becomes visible in the epilot marketplace with a "Beta" label
  • Other organizations can discover and install your solution
  • You'll receive notifications when your app is installed
  • This version becomes immutable to ensure stability for users

During the beta phase, you can gather feedback from users and make necessary adjustments to improve your app's performance and usability. You can also get in touch with our team to discuss your app's promotion and marketing.

Once public, you can continue developing new versions with enhanced features while users benefit from your current release.

Next Steps​

Ready to start your app development journey? Explore these resources:

By following this streamlined process, you'll be able to contribute valuable solutions to the epilot ecosystem and reach organizations throughout the energy industry.