Tidepool Developer Portal

This is Tidepool’s developer microsite. If you are looking for our company web site or want to learn more about our products, please visit tidepool.org.

About this Developer Microsite

The intended audience for this microsite is software developers, but others may also find it valuable. Here are some useful links:

• Our technical documentation:
  • Tidepool technical documentation
  • Tidepool API documentation
• Our source code and developer documentation is on GitHub. The top-level repos are:
  • Tidepool Platform
  • Tidepool Web
    • Documentation
    • Developer guide
    • Data visualization library
    • Timeline visualization library
  • Tidepool Uploader
    • Documentation
    • Developer guide
    • Diabetes device drivers
  • Tidepool Loop
  • Tidepool Mobile
• Our Terms of Use
• Our Privacy Policy
• Our Cookie Policy
• Our Responsible Disclosure Policy
• Our Release Notes

Contributing to Tidepool’s Source Code

Since our founding in 2013, Tidepool has had dozens of volunteer contributors to our efforts. Contributions have come in many forms, including source code, user interface designs, testing, legal and product management.

Because we are an FDA registered entity, any contributions we take from you will be tested thoroughly as part of our Quality Management System (QMS). Depending on our current development priorities, it could be some time before your contribution is tested and made available publicly as part of Tidepool.

We want to be transparent about this, because while we would love to have you as a contributor, we also don’t want you to get frustrated or feel like you’ve wasted valuable time and effort.

Getting Started as a Contributor

If you think you think you’d like to contribute designs, code, or or anything else back to the project, please read our Volunteer/Contributor License Agreement (VCLA) on our Contributors page. This agreement protects you and Tidepool and does not take away any rights that you have to your work.

Depending on what kind of work you are trying to do, you may wish to engage with our source code in different ways:

• Tidepool Uploader: If you’d like to help add device support to the Tidepool Uploader, check out the Tidepool Uploader repository. You can also install the production Tidepool Uploader from our GitHub Releases.
• Tidepool Web: You may wish to build Tidepool Web locally but still run against our hosted back-end services. If so, check out the README. Of course you can also just run the production Tidepool Web.
• Tidepool Platform: If you want to run the entire platform locally, check out the instructions. This will get you running our environment locally using Docker containers.
• Your Applications: You may wish create your own application that accesses Tidepool Platform, our hosted back-end services. If it’s a web app, you may wish to look at Tidepool Web. If it’s a mobile app, check out Tidepool Mobile or Tidepool Loop.
  • Please do not develop or test your app against our production environment without talking to us. Instead, please use our integration environment.
  • Read our data model documentation to understand what medical data we ingest and how it’s organized.

Communication

We use Slack for communication with the open source community. Join us at tidepoolorg.slack.com. We are very grateful to community members who have been so generous with their time supporting other members.

Feel free to drop a note to info@tidepool.org, and it will find the right recipient quickly.

Thank you for your support.