This article explains how to get started with Novus and connect your repository. Connecting your repository allows Novus to scan your app, detect your product areas, and automatically install the necessary tracking tools.

Prerequisites before setup

Before you begin the setup process, ensure you have the following:

• An active GitHub account with access to the repositories you want to connect.
• Permissions to install GitHub applications on your organization or personal account.
• A registered Novus account with an active session.

Note: Novus requests access to your codebase to detect your framework, dependencies, and application structure.

How to start the setup flow

After you register for a Novus account and sign in, you are automatically directed to the onboarding screen.

1. Go to the onboarding page.
2. Review the steps that Novus will perform.
3. Select Get Started → to begin the repository connection process.

Setup instructions

Follow these steps to connect your repository and complete the Novus installation.

1. Select Sign in with GitHub to authorize Novus.
2. Choose your GitHub organization or personal account. If the application isn't installed yet, select Install to grant access.
3. Select a repository from the list. You can use the search bar to find a specific repository.
4. Select the branch you want to use. Novus uses your default branch automatically, but you can choose a different one from the dropdown.
5. Select Continue to start the scan. Novus clones your repository to detect your platform type, metadata, pages, and features.
6. Review the installation pull request. Novus creates a small configuration change and opens a pull request in your repository.