The Civic SIP plugin is the most common method of integrating Civic into a partner website. The plugin interfaces with Civic's request APIs to create and display the QR codes and deep links necessary for users to share their data. To see the integration in action, sign up for your developer account. You'll need one anyways!
Civic already has plugin support available for Javascript, PHP, and Java. These libraries may be useful as reference for your Ruby implementation.
- Your Ruby plugin should fully support the Civic Hosted flow outlined in our docs.
- A ReadMe useable by both interested partners and potential future contributors (see and update CONTRIBUTING.md). ReadMe must include getting started steps for partners new to Civic. See the PHP ReadMe for an excellent example.
- Unit tests to ensure the future health and stability of the project.
- A proof-of-concept page showing a working user sign in to close out the bounty.