This article explains how to complete the setup workflow for your application. The setup workflow connects your codebase to Novus, allowing our AI to automatically scan your repository, detect your framework, and prepare a tailored Novus installation for you.

Prerequisites before setup

Before you begin, you must have access to your organization's GitHub account. You need permission to sign in with GitHub, authorize the Novus app for your organization, and grant read access to the repository you want to connect to Novus.

Additionally, the Novus setup workflow requires your application to be built on a supported platform. Supported platforms include:

• Web applications (including frameworks like React)
• Native iOS apps (built with SwiftUI, UIKit, or Native Hybrid)
• Native Android apps (built with View, Compose, or Native Hybrid)
• Cross-platform mobile apps built using React Native, Expo, Flutter, and MAUI

How to start the setup flow

To begin the setup workflow, add a new application to your subscription. If you leave before finishing, you can return to the setup flow by navigating to your Dashboard and selecting Continue Setup in the setup progress card.

Step by step instructions

1. On the welcome screen, review the onboarding overview and select Get Started.

2. On the Select repo screen, expand the Connect to GitHub section and select Sign in with GitHub.

3. Follow the GitHub prompts to authorize access and select your organization.

4. Once connected, expand the Select a repository section. Use the search bar to find and choose the repository for your application.

5. Review the configuration section at the bottom of the screen. If you need to target a branch other than the default, select the branch dropdown to search and choose your preferred branch.

6. Select Continue to start the analysis.

7. On the Scanning your repository screen, wait while the AI analyzes your codebase. The screen displays a list of tasks the AI is completing on your behalf, such as detecting your platform, mapping visitor and account metadata, identifying product areas, and discovering pages and click events. You can use the side chat panel to talk to the AI about your product goals while you wait.

8. When the scan finishes, you reach the Install Novus step. Here, the AI generates a pull request that contains the exact code needed to install Novus in your application.

9. Select the provided link to review the pull request in GitHub, and merge the code when you are ready.