i5okie/traction

Traction is designed with an API-first architecture layered on top of Hyperledger Aries Cloud Agent Python (ACA-Py) and streamlines the process of sending and receiving digital credentials for governments and organizations.

Traction

Table of Contents

• What is Traction?
• Start using Traction
• What are the benefits of using Traction?
• What is Traction comprised of?
• Start contributing to Traction
• Who is maintaining Traction?
• How is Traction licenced?
• Engage with the community

What is Traction?

Traction is a digital wallet solution comprised of plugins layered on top of Hyperledger Aries Cloud Agent Python (ACA-Py) and streamlines the process of sending and receiving digital credentials for governments and organizations.

Its open-source foundation makes it easy to integrate digital trust technology into existing lines of business applications, without having to stand up, maintain and manage an instance of ACA-Py themselves. Future functionality could include machine-readable governance and more.

Start using Traction

Running Traction: to run a local instance of traction, see the documentation in scripts.

Deploying Traction: Helm charts for deploying Traction and Endorser to Openshift (BC Gov Traction team specific): charts.

What are the benefits of using Traction?

Traction makes it easier to integrate digital trust technology into existing line of business applications.

• API-first Architecture: Traction is designed with an API-first architecture, this RESTful API allows for integration into existing line-of-business applications already being used by organizations, the Tenant user interface is built on this API to enable adoption prior to integration and for low-use functions.
• Enhanced Interoperability: Hyperledger Aries makes Traction more broadly compatible with existing technologies used by governments and organizations around the world.
• Multi-tenancy: Rather than having multiple digital tools to integrate with organizations, one scalable instance of Traction can be used to participate in the digital trust ecosystem, control all connections, and more easily share data.
• Higher Scalability: Traction is open-source technology, encouraging collaborative refinement, faster release, and higher scalability.

What is Traction comprised of?

• ACA-Py + plugins
• Tenant UI
• Endorser Services

Start contributing to Traction

Traction is an open-source technology project that welcomes collaboration.

If you would like to contribute to Traction, please review the following:

• Contributing
• Code of Conduct
• Compliance

Developers: devcontainers

To aid in developers, there are 2 devcontainers: plugins and tenant-ui.

The devcontainers and associated vscode launch files are for convenience only, they are not mandatory for developing and debugging. Please feel free to develop anyway you choose.

1. In VS code, open plugins.
2. Follow all prompts to open the devcontainer.
3. In a second VS Code window, open services/tenant-ui
4. Follow all prompts to open the devcontainer.
5. in plugins, start up the ACA-Py / Traction instance: Run and Debug view, "Run/Debug Plugin", start/F5
6. in services/tenant-ui, start up the backend api: Run and Debug view, "backend - run dev", start/F5
7. in services/tenant-ui, start up the frontend api: Run and Debug view, "frontend - run dev", start/F5
8. in services/tenant-ui, load a Chrome browser for debugging frontend: Run and Debug view, "frontend - chrome", start/F5

If all starts up without a hitch, then you should be able to breakpoint the tenant-ui frontend (Vue/Chrome), tenant-ui backend api (Node.js) and traction plugins (Python) for local debugging.

Out of the box, the above will use the following ports:

• ACA-Py/Traction Plugins: 3000, 3001 (admin)
• Tenant Proxy: 8032
• Traction DB: 5432
• Tenant UI backend server: 8080
• Tenant UI frontend server: 5173

Note that Tenant Proxy and Traction DB are startec via docker compose when starting ACA-Py/Traction Plugins

Repository workflow

Currently authorized users can create a branch and run a pull request to merge in changes. Unauthorized can always create a fork.

Rebasing of a branch

git fetch --all
git pull

git rebase origin/main
git push --force

Who is maintaining Traction?

The Province of British Columbia is maintaining Traction as an open-source project.

Maintainer(s):

• Jason Sherman
• Jason Syrotuck
• Lucas O'Neil
• Jamie Popkin

How is Traction licensed?

Traction is licensed under Apache License 2.0 which can be reviewed here.

Engage with the community

Connect with others

• on Discord: EMDT Public Discord Channel
• for Aries discussion see the Hyperlerger Aries Github participation section