Getting Started
Run your first Release Readiness Check in under 5 minutes.
Before you begin
- An Electron project with a
package.json - A GitHub account (for OAuth sign-in and repo connection) or email
- Your Electron project in a GitHub repository
Create your account
Sign up using one of two methods:
GitHub
One-click sign-in. Automatically connects your repos.
Email & Password
Sign up with email. You'll need to verify it via a confirmation link.
Complete your profile
After your first login, a profile setup modal will appear. Enter your full name to continue. If you signed up with GitHub, your name and avatar will be pre-filled.
Profile Setup
Full Name * · Email (read-only) · Avatar
Create your first project
From the dashboard, click "New Project". The wizard will guide you through:
Project Name
Give your project a recognizable name.
Distribution Goal
Store — check against Mac App Store and Microsoft Store requirements.
Direct — check signing, notarization and auto-update for downloads from your website.
Target Platforms
Code Source
Connect a GitHub repository. The check reads it from your default branch.
Run your first check
Open Readiness Check in the sidebar and click "Run Readiness Check". The check reviews your project for what blocks a signed release.
Checks package.json, build tool configuration, main process, preload scripts, dependencies, security settings, and platform-specific requirements.
Review your score
After the analysis completes, you'll see a readiness score (0–100) and a detailed breakdown by category. Each category shows:
Pass
Warning
Fail
Each finding includes an explanation and actionable recommendations to improve your score.
What's next?
Readiness Check Guide
Check categories, scoring, and how to fix common issues.
Code Signing & Notarization
Set up Apple code signing, Windows Authenticode, and macOS notarization.
Store Publishing
Publish to Mac App Store, Microsoft Store, and Snap Store.