Getting started overview

This guide provides a structured approach to initiating your work with Zube, a project management tool optimized for development teams using GitHub. The process covers account creation, GitHub repository integration, and understanding the core functionalities that bridge GitHub's native issue tracking with Zube's agile planning features. Zube aims to provide a kanban board and sprint planning tools that complement GitHub's existing issue and pull request workflows Zube homepage. By following these steps, users can establish a functional Zube environment and begin managing development tasks.

The primary goal is to enable users to view and interact with their GitHub issues through Zube's interface, leveraging Zube's project management capabilities without duplicating data entry. Zube's integration strategy focuses on syncing data bi-directionally, meaning changes made in Zube are reflected in GitHub and vice-versa Zube's official site. This synchronization is critical for maintaining a single source of truth for project status and task assignments.

Key steps include:

  1. Account Setup: Creating a Zube account and configuring initial organizational settings.
  2. GitHub Integration: Connecting Zube to your GitHub account and selecting repositories for management.
  3. Project Creation: Setting up your first project within Zube to visualize and manage GitHub issues.

Quick reference table

Step What to do Where
1. Sign Up Create a new Zube account Zube Signup Page
2. Connect GitHub Authorize Zube to access GitHub repositories Zube Settings > Integrations
3. Create Project Define your first project and select GitHub repositories to sync Zube Dashboard > New Project
4. Configure Boards Set up Kanban or Sprint boards for issue visualization Project Settings > Boards
5. Invite Team Add team members to your Zube organization and projects Zube Settings > Team

Create an account and get keys

To begin using Zube, the initial step involves creating an account. Zube offers a free tier for up to three users, which can be used to evaluate its features before committing to a paid plan Zube pricing details. Full pricing information for paid tiers, including the Standard tier starting at $24 per user per month, is available on their pricing page.

Account creation

  1. Navigate to the Zube signup page.
  2. Choose a signup method: You can typically sign up using your email address or directly via your GitHub account. Using GitHub simplifies the subsequent integration process.
  3. Follow the prompts to set up your organization name and initial user details.

GitHub integration

Zube's core functionality relies on its deep integration with GitHub. After creating your Zube account, you will be prompted to connect your GitHub account. This connection allows Zube to access your repositories, issues, pull requests, and comments. This is a critical step for Zube to function as an overlay for your GitHub-managed projects.

  1. In your Zube dashboard, navigate to Settings and then Integrations.
  2. Locate the GitHub integration option and click Connect.
  3. You will be redirected to GitHub to authorize Zube. Review the requested permissions carefully, as Zube requires access to repositories and issues to provide its services. GitHub's permission model allows for granular control over what applications can access GitHub authorized integrations documentation.
  4. Grant the necessary permissions. After authorization, you will be redirected back to Zube.

API access and keys

Zube provides an API for programmatic interaction, which can be used for advanced integrations and automation. While the primary getting started experience focuses on the web interface, understanding API access is important for extending Zube's capabilities. API keys are typically generated within your Zube account settings.

  1. Once logged into Zube, go to Settings > API Tokens (or similar section depending on Zube's current UI).
  2. Generate a new API token. Ensure you copy this token immediately upon creation, as it may not be retrievable later for security reasons. Treat API tokens as sensitive credentials, similar to passwords.
  3. The Zube API is designed to allow external systems to create, update, and query issues, projects, and other Zube entities, often mirroring the functionality available through the web interface.

Your first request

For Zube, a "first request" typically refers to creating your first project and syncing it with a GitHub repository, as Zube primarily acts as a management layer over GitHub issues rather than an independent API endpoint for issues. There isn't a direct "Hello World" API call in the traditional sense, but rather a configuration process to see your GitHub data within Zube.

Creating your first project

  1. From your Zube dashboard, click on New Project or a similar button to initiate project creation.
  2. Provide a project name and description.
  3. Crucially, select the GitHub repositories you wish to associate with this Zube project. Zube will then begin syncing issues and pull requests from these repositories. This synchronization populates your Zube boards with existing GitHub data.
  4. Configure your project boards (e.g., Kanban, Sprint). Zube allows you to customize columns and workflows to match your team's agile methodology.
  5. Once the project is created and repositories are synced, you will see your GitHub issues appear as cards on your chosen boards within Zube. This visual representation of your GitHub issues within Zube constitutes the "first successful interaction," demonstrating the integration is working.

Example API interaction (optional)

If you intend to interact with Zube programmatically, the first request would typically involve authenticating with your API token and then listing existing projects or issues. While Zube's documentation is the definitive source, a common pattern for REST APIs includes a GET request to an endpoint like /api/v1/projects.

Using curl, an example might look like:

curl -X GET \
  -H "Authorization: Token YOUR_API_TOKEN" \
  "https://api.zube.com/v1/projects"

Replace YOUR_API_TOKEN with the API token generated from your Zube settings. This request would list all projects associated with your Zube account, confirming that your API token is valid and Zube's API is accessible.

Common next steps

After successfully setting up your Zube account, integrating GitHub, and creating your first project, several common next steps can enhance your team's productivity and collaboration:

  1. Invite Team Members: Add your team members to your Zube organization and assign them to relevant projects. Zube's pricing is often per-user, so consider your team size when inviting Zube pricing tiers.
  2. Configure Workflows: Customize your project boards (Kanban, Sprint) with specific columns and automation rules to match your team's development workflow. This includes defining states like "To Do," "In Progress," "Code Review," and "Done."
  3. Utilize Agile Features: Explore Zube's sprint planning, backlog management, and reporting features to manage your agile development cycles effectively. This includes setting sprint goals and tracking progress.
  4. Create and Manage Issues: Begin creating new issues directly within Zube, or manage existing GitHub issues that are now synced. Observe how changes made in Zube (e.g., moving a card, adding a comment) are reflected in GitHub and vice-versa.
  5. Explore Advanced Integrations: Zube may offer integrations with other tools beyond GitHub, such as Slack for notifications or other CI/CD pipelines. Check the Zube documentation for a complete list of supported integrations.
  6. Review Documentation: Refer to Zube's official documentation for in-depth guides on specific features, best practices, and advanced configurations.

Troubleshooting the first call

Encountering issues during the initial setup or first API call is common. Here are some troubleshooting steps:

GitHub integration issues

  • Permissions: Ensure Zube has the correct permissions to access the desired GitHub repositories. You might need to re-authorize Zube from your GitHub settings or within Zube's integration settings. Check your GitHub Authorized OAuth Apps to review permissions.
  • Repository Selection: Verify that you have selected the specific GitHub repositories you want to sync when creating or editing your Zube project. Zube will only display issues from selected repositories.
  • Sync Delays: Sometimes, initial synchronization can take a few minutes, especially for repositories with many issues. Refresh your Zube project view after a short wait.

API token issues

  • Invalid Token: Double-check that you have copied the API token correctly and that there are no leading or trailing spaces. API tokens are typically case-sensitive.
  • Expired Token: While less common for initial setup, some API tokens have expiration dates. If you're using an older token, generate a new one.
  • Incorrect Endpoint: Ensure the API endpoint URL (e.g., https://api.zube.com/v1/projects) is correct and matches the documentation.
  • Authorization Header: Verify that the Authorization header is correctly formatted as Token YOUR_API_TOKEN.

General connectivity issues

  • Network Connectivity: Confirm your internet connection is stable.
  • Firewall/Proxy: If you are behind a corporate firewall or proxy, ensure it is not blocking access to api.zube.com.
  • Zube Status: Check Zube's official status page (if available) to see if there are any ongoing service outages.

If these steps do not resolve your issue, consult Zube's official support documentation or contact their support team for assistance.