Import a GitHub repository

​

Step 1: Create an account

Navigate to cubecloud.dev, and create a new Cube Cloud account.

​

Step 2: Create a new Deployment

Click Create Deployment. This is the first step in the deployment creation. Give it a name and select the cloud provider and region of your choice.

​

Step 3: Import repository from GitHub

Click Import from a GitHub repository and complete any requested GitHub authorization. After authorization, you should see this screen: Select the account that owns the repository (your personal account or organization). If it is missing, choose Add new organization in the account selector to open GitHub’s app installation dialog. Install the Cube Cloud GitHub app on that account and grant it access to the repository. Complete any required organization-owner approval before selecting the repository. See GitHub App permissions for access requirements and creating a repository for the new-repository flow. Select your repository and the desired branch to use as the default. If the repository is a monorepo, you should also provide the path to the Cube project within it. Deployments connected to a Git monorepo will trigger a rebuild only when committed files begin with the provided path.

​

Step 4: Connect your Database

Enter your credentials to connect to your database. Check the connecting to databases guide for more details. In the UI it’ll look exactly like the image below. If you run into issues here, make sure to allow the Cube Cloud IPs to access your database. This means you need to enable these IPs in your firewall. If you are using AWS, this would mean adding a security group with allowed IPs.

​

Step 5: Generate the Data Model

Step four in this case consists of generating data models. Start by selecting the database tables to generate the data models from, then hit Generate. Cube Cloud will generate the data models and spin up your Cube deployment. With this, you’re done. You’ve created a Cube deployment, configured a database connection, and generated data models! You’re ready for the last step, running queries in the Playground.

​

Step 6: Try out Cube Cloud

Now you can navigate to Playground to try out your queries or connect your application to Cube Cloud API.