App Deployment
Push your local Sim IDX project to GitHub, import it into the Sim dashboard and ship the first build.
Deploying publishes your app on Sim’s managed infrastructure so it can continuously index data and serve production-ready APIs. This guide shows how to connect a local project to GitHub, import it into the Sim dashboard and trigger the first build.
Before you continue, complete the Quickstart to install the Sim CLI and initialise an app.
Create GitHub repo
Create a new repository on GitHub
Open GitHub and create a new repository named after the folder that contains your project.
In the Quickstart we used my-first-idx-app
.
Push app to GitHub
When you ran sim init
, besides initializing your app, the CLI created a Git repository and committed the first version of your code.
Point the repo at GitHub and push the commit.
Push the first commit to GitHub
Copy the code snippet from GitHub for pushing a code snippet from the command line. It should look like the following:
Import repo
Open the Sim dashboard at sim.dune.com, select IDX in the sidebar and click Import Repo. The first time you do this you will have to install the Dune Sim GitHub App.
Import your new GitHub repo into the Sim IDX dashboard
Install GitHub App
Select where to install the GitHub App
Choose the GitHub account, select allow all or only the repositories you need and click Install. After installation you return to the import screen and pick your repo.
Configure & deploy
Review app settings and deploy
Review the settings for the App name, the optional description, then press Deploy. The dashboard will show the deployment with status Building.
Monitor deployment progress
Deployment building and ingesting data
Return to the Sim dashboard, click on your app in the IDX tab and watch the new deployment move from Building → Ingesting → Ready. Once the status shows Ingesting, your APIs and database are live and serving data.
Next steps
Your first build is now running. Head over to the App Page to learn where to find the database connection string, generated API endpoints and deployment status. Once you have your first deployment live, you can start iterating on your Listener Contract to capture additional onchain events and shape your database schema.