Skip to content

Deploy to Render

You can host and share your Toolpad apps on Render in a few minutes, for free.


Pushing your Toolpad app to GitHub

  1. With a GitHub account, we can create a new repository using the + button available in the header menu, followed by New repository. Then, select an appropriate name:
GitHub new repo

Creating a new GitHub repository

  1. If the Toolpad app is not currently a Git repository, we can run

    git init

    to initialise it.

  2. We can set the newly created repository on GitHub as the remote for our locally running Toolpad app, using:

    git remote add origin <REPOSITORY-URL>

    Replace <REPOSITORY-URL> with the URL of the repository we just created on GitHub.

  3. Once you are done making changes to your Toolpad app, verify that we are on the main branch, commit these changes and push them to GitHub.

    git add .
    git commit -m "pushing a new version"
    git push origin main

Creating a new app on Render

  1. With a Render account, we can create a new Web Service:
Render new web service

Creating a new Render Web Service

  1. Depending on whether the visibility of the GitHub repository is set to private or public, we will need to either connect our GitHub account to Render, or paste in the URL of the repository we created above:
GitHub new repo

Connecting GitHub to Render

  1. If using a private repository, we need to search for and select the repository we intend to deploy once connected to GitHub:
GitHub repo on Render

Connecting our GitHub repository

  1. With the repository selected, we advance to deployment configuration. Render can guess that we are deploying a Node app. Set the name which will appear in the URL of our deployed app, like <APP-NAME>
Render deployment config

Setting the deployment configuration

  1. The build and start commands will be set to

    $ yarn; yarn build
    $ yarn start

    by default. We can leave this unchanged.

  2. Select an appropriate instance type for your deployment.

Render deployment commands and plan

Setting deployment commands and choosing an instance type

  1. Select Create Web Service to trigger the deployment. We will be redirected to the streaming logs of the in-progress deployment.

  2. uses 14.7.0 as the default Node version. Toolpad requires version 18.17.1 as the minimum Node version. We can change the default by setting a NODE_VERSION environment variable for our deployment:


Overriding the default Node version

  1. Once this is successfully complete, we can access our Toolpad app on <APP-NAME>
Render deployment complete

Deployed successfully

That's it! We're up and running in a few minutes.

Make changes, push to GitHub, and your app will automatically redeploy each time.

Check out the Render documentation for more advanced settings, like adding environment variables to your app.