Getting Started

Prerequisites

• A GitHub account or organization
• A Slack workspace where you have permission to install apps
• Admin access to the repositories you want to monitor

Step 1: Install Slack App

Start by adding Nudgy Bot to your Slack workspace. This lets the bot send notifications and display the Home Tab interface.

1. Click the Get Started Free button on our homepage
2. Select your Slack workspace
3. Review and approve the requested permissions
4. You'll be redirected back after successful installation

Step 2: Open the Home Tab

All configuration happens in the beautiful Slack Home Tab interface:

1. In Slack, search for @Nudgy Bot
2. Click on the bot name to open its conversation
3. Click the Home tab at the top
4. You'll see the configuration interface ✨

Step 3: Link GitHub Organization

Connect your GitHub organization with one click:

1. In the Home Tab, click "Add Organization"
2. You'll be redirected to GitHub
3. Select your account or organization
4. Choose which repositories to authorize
5. After installation, you're automatically redirected back to Slack
6. Your Home Tab refreshes with your linked organization 🎉

Step 4: Add Repositories

Configure which repos to monitor and where notifications go:

1. Click "Add Repository from [Your Org]"
2. Choose a repo from the dropdown (shows only your authorized repos)
3. Select which Slack channel receives notifications
4. Customize reminder timing or use defaults
5. Optionally enable weekly stats
6. Click "Add Repository" — Done! 🚀