Deploy Sample Apps to App Platform

App Platform offers sample applications that you can add to your GitHub account and then deploy on App Platform. Each app deploys a basic “Hello, world!” style website that you can view in your browser after deployment. This can help you learn how App Platform works and test different languages on the service.

Along with the application itself, each app contains a spec file and a file native to its programming language that App Platform uses to detect the app’s language. For example, in the Node.js sample app, App Platform uses the app spec file (.do/app.yaml) to configure the app for deployment, and the package.json file to determine that the app uses the Node.js framework. These files are important for understanding how App Platform works.

For a list of available languages, see our list of sample apps.

Apps include two types of deployable resources: app resources for running code, and database resources for managed databases.

App resources are made up of components, which define how code is built, deployed, and run. Supported component types include web services, static sites, workers, and jobs. Web services, workers, and jobs run in containers from a repository or container image, while static sites are hosted from a directory of static files on DigitalOcean’s CDN.

Deploy a Sample App Using the Control Panel

To deploy a sample app using the DigitalOcean Control Panel, click Create, then select App Platform from the dropdown menu.

On the Create an app screen:

• Click the Templates tab, then choose an app from the grid or use the search to find a starter app.

• Click Deploy on the starter app you want, then choose an option:

  • Create new repository in GitHub creates a new repository in your GitHub account using the sample app.
  • Deploy from template repository deploys the app directly from the sample app’s repository.

  We recommend creating a new repository so you can customize the app later and redeploy it as needed.

Create new repository in GitHub

On the Create New Repository page, select an owner and provide a name for the repository, then click Create repository. GitHub creates a new repository in your account from DigitalOcean’s template repository.

After creating the repository, return to the Create an app page and refresh it. When the page updates, GitHub is selected as the Git provider. Click the Repository dropdown menu, select the new sample app repo, then click Next.

Deploy from template repository

If you choose the Deploy from template repository option, the app deploys directly from the sample app’s repository and you do not need to provide any additional information.

Configure Resource Settings

The Resource settings table displays configuration settings, some of which the detection system auto-fills. Click Edit beside settings you want to change.

You can configure the following settings:

• Name: A unique name for the component.

• Resource type: The type of component to deploy (web service, static site, worker, or job).

  Note

  The selected Resource type determines which fields in the following list are displayed in the Resource settings table.

• Branch: The branch to deploy from. You can enable automatic redeploys when changes are made to this branch.

• Instance size: The amount of memory (RAM), CPUs, and bandwidth allocated to the component. You can choose shared or dedicated CPUs. Shared CPUs share their processing power with other DigitalOcean users. Dedicated CPUs are dedicated solely to your app. We recommend dedicated CPUs for more resource-intensive applications that require consistent high performance and autoscaling.

• Containers: The component's scaling settings. The instance size you select determines the scaling options available. For more details, see How to Scale Apps in App Platform.

• Build command: A custom build command to run before the app is deployed. This is useful for compiling assets, installing dependencies, or running tests before deployment.

• Run command: A custom run command for the application to run after deployment. If no run command is specified, the default run command for your app's language is used, such as npm start for a Node.js app. For Dockerfile-based builds, entering a run command overrides the Dockerfile's entrypoint.

• Output Directory: For static sites only. An optional path to where the build assets are located, relative to the build context. If not set, App Platform automatically scans for these directory names: _static, dist, public, build.

• Public HTTP port: For web services only. The port that the app receives HTTP requests on. The default port is 8080.

• Internal ports: For web services only. The port that the app receives internal requests on.

• HTTP request routes: For web services and static sites only. The URL path where the app can be accessed, such as your-app-v3cl4.ondigitalocean.app/api. If not specified, the app is accessible from the provided hostname's root.

  Note

  The service must bind to and expose the HTTP port on the network interface 0.0.0.0, rather than on the localhost (localhost) or loopback interface (127.0.0.1).

  Full HTTP request path preservation for services is not available in the Control Panel. Instead, set the preserve_path_prefix annotation in the App Spec to true.

• Environment variables: Key-value pairs available to your app at runtime that let you keep configuration separate from application code. Use them to provide secrets, API keys, and other external settings, such as connection details for an external database.

App Platform uses cloud-native buildpacks to build components and applies the buildpack's default build and run commands. See the cloud-native buildpack reference for details about supported buildpacks.

Add a Database

In the Add a Database section, you can connect a database to your app:

• To provision a new dev database directly within your app, click Create dev database.
• To connect an existing DigitalOcean Managed Database, click Attach DigitalOcean database.
• If your database is hosted outside of DigitalOcean, add environment variables in the Resource settings table to provide the connection details.

See How to Manage Databases in App Platform for details on connecting databases.

After connecting a dev or managed database, App Platform automatically injects the necessary connection information into the relevant component’s environment variables.

Set App-Level Environment Variables

App-level environment variables are available to all components in your app. Use them for shared configuration, secrets, API keys, or other values your app needs at build time or runtime.

To set app-level environment variables:

• Click Edit in the App-level environment variables section.
• Click Add environment variable, type a key and value, then select a scope.
• Select Encrypt to obscure the value in build, deployment, and application logs.

For dynamic, app-specific variables that your app can reference, see Use Bindable Variables.

Choose Datacenter Region

In the Datacenter region section, click the Choose a datacenter region dropdown menu, then select the region to deploy your app into. To minimize latency, choose the region geographically closest to your users.

Region selection is not available for static sites. Static resources are served through DigitalOcean’s global CDN.

Finalize

In the Finalize section, you can update the app's name and project:

• In the Choose a unique app name field, type a name for the app.
• In the Select a project dropdown menu, select an existing project and environment or click Create new project.
• If you create a new project, enter a name, then select a purpose and environment for the new project.

When finished, review your configuration settings and pricing details in the Summary section, then click Create App.

App Platform creates the app using the selected settings and deploys it automatically. After deployment, you can view it using the URL at the top of the app's Overview page.

List of Available Sample Apps

We offer sample apps for the following languages and frameworks. Each link opens the sample app’s repository in GitHub.

We provide the following sample apps:

• Docker
• Asp .Net using Docker
• Spring Boot using Docker
• Express.js
• Flask
• Gatsby
• Go
• Gin
• Hugo
• Laravel
• Next.js
• Node.js
• Nuxt.js
• PHP
• Python
• React
• Ruby
• Static assets
• Ruby on Rails
• Apt