Truffle Teams Quickstart

Truffle Teams is currently in beta, so if you run into any glitches or bugs, please raise an issue on the Truffle Teams GitHub repository.

This page will take you through the basics of creating a Truffle Teams account and linking it to a Truffle project repository.

Note: Before you begin, make sure that you have a GitHub repository containing a Truffle project.

  1. Creating an Account
  2. Starting Builds

To start, navigate to https://my.truffleteams.com (this link will open in a new window).

If you're not already logged in to your GitHub account, Github will prompt you to do so.

If you are a member of any organizations other than your personal account, you'll be prompted to select an org to contiue with installation. Orgs with an existing Truffle Teams installation will have a Configure > link.

Truffle Teams DATA view

Next you'll be asked for permission to link Truffle Teams to one or more of your GitHub repositories. Select the repositories you wish to add and click continue. Select either All repositories to add all repos in this account/org to teams or Only select repositories to select individual repos from the dropdown.

Note: We can always add a repo later if necessary. See the Adding Repositories documentation for more informaiton.

Finally, click the Install button to install Truffle Teams on the selected repos and be redirected to the BUILDS page.

Why do we need certain permissions?: Please see the Permissions Disclosure section for a full breakdown of why we're asking for each permission.

Truffle Teams DATA view

We then arrive at the home screen and see the repos we've added--let's commit some code and see how Truffle Teams will automatically run our tests!

Builds will start automatically once a new commit is pushed to any branch of a repository added to Truffle Teams. You will see the build queued in both the Truffle Teams interface on the BUILDS page and on GitHub with the commit itself.

Truffle Teams DATA view

This quickstart showed you the basics of the Truffle Teams testing workflow, but once your contracts are deployed there's more to learn about monitoring deployed contracts.

We're in a cycle of rapid development; constantly adding new features and refining existing ones. If you run into any glitches or bugs, please raise an issue on the Truffle Teams GitHub repository. To get notified of the latest updates consider signing up for the Truffle Teams mailing list.