Skip to main content

Deploy and Export

Export your Hyper Studio project as production-ready source code or publish it directly to the HYPER cloud.

Publishing to Cloud​

The Publish button is available at the top right corner of the Studio interface. This allows you to deploy a temporary instance of your application.

Pre-deploy Analysis​

When you click Publish, Hyper performs a pre-deploy analysis to check for issues in your configuration (for example, using reserved keywords in field names).

  • All Checks Passed: If everything looks great, you can proceed to deploy.
  • Issues Found: If issues require attention, you can view the suggestions. Click Resolve with Hyper AI to automatically fix the issues using AI.

Deployment Limits​

  • By default, the deployment is scheduled for automatic deletion 30 minutes after creation.
  • You can extend the expiry time by clicking the + button in the "Extend Expiry" column.
  • Each extension adds 30 minutes, up to a maximum total duration of 2 hours.

Deployment Status and Actions​

  • If Deployment Fails: You can click Show logs to see exactly what went wrong and click Redeploy to try again.
  • If Deployment Succeeds: You will receive URLs for both the Frontend and Backend to check out your live application.
  • Sample Data: If enabled in your project, this section allows you to click Deploy Seed Data to run the database seeder (using Faker) and populate the app with sample data. Once inserted, you can click Re-run if needed.

Exporting your project​

Go to Generate Code in the top navigation bar to export standalone code.

Step 1: Select export type​

Choose your preferred codebase type:

  • Backend — Generates standalone Node.js code with Express framework. Includes API routes, middleware, and database models based on your Collections.
  • Frontend — Generates standalone React code with shadcn components. Includes pages, forms, and UI components based on your Areas configuration.

Step 2: Export project​

Click Export Project to start the code generation process.

warning

During export, code analysis runs to validate your configuration. If issues are detected, the process will stop. You can choose to bypass the analysis and proceed with the export, but you do so at your own risk as it may lead to errors in the generated code.

Common issues include:

  • Missing required field configurations
  • Invalid relationship references
  • Incomplete collection setup

Step 3: Download source code​

Once generation completes, access your files from the Downloads panel. You can open this panel by clicking the Download icon right beside the Publish button at the top right corner.

Downloads​

The Downloads panel displays all generated exports for your project. Each entry shows:

ColumnDescription
Generated ByTeam member who initiated the export
Typefrontend or backend
DateTimestamp of when the export was created
StatusCurrent state of the generation process
Download LinkAction to download the generated files

Status indicators​

StatusMeaning
QUEUEDExport request is waiting to be processed
BUILDINGCode generation is in progress
GENERATINGFiles are being packaged
READYExport complete — ready for download
FAILEDExport encountered an error

Click Refresh to update the status of pending exports.

What's included​

Backend export​

The generated backend includes:

  • Express server — Set up with middleware and error handling
  • API routes — RESTful endpoints for all Collections
  • Controllers — Business logic for CRUD operations
  • Models — Database schemas matching your Collection fields
  • Authentication — Auth middleware based on your Roles configuration
  • Validation — Input validation matching your field constraints

Frontend export​

The generated frontend includes:

  • React application — Modern React with TypeScript
  • shadcn/ui components — Pre-styled UI components
  • Pages — Views matching your Areas configuration
  • Forms — Input forms for creating and editing records
  • Data tables — List views with sorting and filtering
  • API integration — Hooks for connecting to your backend

Manual Deployment​

After downloading the source code, you can deploy it to any hosting provider:

  1. Extract the downloaded archive.
  2. Install dependencies with npm install.
  3. Set environment variables.
  4. Run npm run build for production builds.
  5. Deploy to your preferred platform.
note

Generated code is standalone and doesn't require Hyper to run. You have full ownership of the exported source code.

Use these pages to prepare your project before exporting:

  • Collections — Define your data structure before exporting
  • Areas — Set up UI layouts for frontend exports
  • Roles — Set up authentication for backend exports