/intellij-plugin

Realtime collaboration and communication for dev teams

Primary LanguageKotlinBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

TeamHub IntelliJ Plugin GitHub pre-release pre-release

TeamHub is a realtime collaboration platform for development teams

This plugin utilises the TeamHub SDK to integrate TeamHub into the Jetbrains IDE family including Android Studio


Contributing bounties available

TeamHub needs you! We are looking for IntelliJ Platform SDK ninjas to help us implement the IntelliJ plugin, adding new features as they are made available in the TeamHub SDK

Check out our current issues to see where you could help out

If you don't have any prior experience of the IntelliJ Platform but maybe you are still a Kotlin ninja then check out the IntelliJ docs and forum, it's also useful to check the code as the documentation can be a little thin in areas

Getting Started

First off, make sure you have IntelliJ 2018.3 or later installed

  • Import the intellij-plugin gradle project into IntelliJ using Check out from Version Control or Import project if you have already cloned the repo
  • If IntelliJ complains about an Unlinked Gradle Project then select the option to import it
  • Once imported you can use the runIde gradle task to run the project, see Running TeamHub

Alternatively, you can simply install the latest release of the plugin to see it in action, once downloaded use Settings/Preferences -> Plugins -> ⚙️ -> Install Plugin from Disk and then follow the instructions below

Running TeamHub

  • The plugin will show a Team window in the bottom left of the IDE once:

    • A GitHub account has been added under Settings/Preferences -> Version Control -> GitHub
    • A project is open that contains a GitHub repo which you have write access
    • There is at least one other member with write access that has TeamHub installed
  • The easiest way to do this is:

    • Send yourself an invite to the sample-repo via our small script that uses the GitHub API
    • Once accepted sign into GitHub via IntelliJ
      Welcome screen -> Check out from Version Control -> Log in to GitHub
    • Then select TeamHubApp/sample-repo from the URL drop-down list on the Clone Repository dialog
    • After the project has loaded you should see the Team window in the bottom left of the IDE