Getting Started

Creating a New App

If you're starting a brand new app project that you'd like to deploy on Adaptable or are just interested to see how Adaptable works, this guide is for you.

If you have an existing app you'd like to deploy on Adaptable, check out our guide on deploying your existing app.

»What is a Starter?

An Adaptable Starter is a template that you can use to create a new app from scratch. Our Starter library includes many popular app types, like a FeathersJS real-time chat app and a basic To Do List app, based on Express, Prisma, and MongoDB. A starter will create a new GitHub repo for you, populate it with code for your chosen app type, and deploy the app on Adaptable, complete with all the services your app type requires.

To get started creating a new app from a Starter, click the button below.

»Step 1: Choosing a Starter

First, pick the type of app you want to create by choosing a Starter. Each starter has a Learn More link that has information about the starter.

Choosing a starter

If you're not already signed in, you'll need to sign in with your GitHub account.

The next screen explains the actions your chosen starter will perform. Click Next to continue.

Starter information

»Step 2: Connecting to GitHub

If this is your first time using Adaptable, you'll need to connect Adaptable to one or more of your GitHub scopes. This will allow Adaptable to:

  • Create your new GitHub repo.
  • Populate it with template source code from the starter.
  • Monitor the repo and update the Adaptable deployment on every push to your main branch.

A GitHub scope can be either a GitHub organization you belong to or your personal scope.

Click the Connect to GitHub Scope button.

Connect to GitHub

Choose which scope you'd like to connect Adaptable to.

Install Adaptable on GitHub

And finally, click the Install & Authorize button.

Authorize Adaptable on GitHub

»Step 3: Choosing Names for Your GitHub Repo and Adaptable App

Choose a connected GitHub scope where you'd like to create your new repository and choose a name that's unique within that GitHub scope. If you don't see the GitHub scope where you want to create the new repository, click Connect to more GitHub scopes to install Adaptable on another GitHub scope.

Choosing a repo name

Click Next to continue.

Then choose a name for your app project on Adaptable. It must be unique among all other app names on Adaptable.

Choosing an app name

Click Create Repo & Deploy to start the process of creating and deploying your new app.

This process can take a few minutes, depending on which Starter you selected. Adaptable shows you progress on each of the starter operations.

Deploying the starter


Once deployment is complete, Adaptable provides information about the actions the starter performed.

Starter complete

Adaptable shows the following information:

  • A link to the new GitHub repo that was created by the starter.
  • The public URL for your new app, running on the Adaptable Cloud.
  • Information about which repo branch is enabled for continuous deployment.

»What's Next? Start Writing Code!

Click the name of your new GitHub repo to go to its main page. You can now clone the repository and start writing code.

Each time you push to the main branch, Adaptable will automatically deploy your code changes.


Click the Starter Docs button to go do the Starter Guide for ideas on how to start building your project on top of your newly deployed starter.

To manage settings for your app and to access logs and other information, click the View App Status button. Or to see all your Adaptable apps, go to your Dashboard.

To learn more about managing your Adaptable apps, see Managing Apps.