README
¶
Proxeus Core
Proxeus combines a powerful automation tool with a form builder, document generator and blockchain connection - enabling you to digitize, secure, and tap into the value of data flows. Access the full source code of available modules and extensions @ProxeusApp.
User Guides
Get help to make the most of the platform in the User Handbook.
To learn more about Smart Contracts using Solidity, see the documentation in the proxeus-contract.
For detailed information about token setup, check the XES-Payment project. Software architecture and other details are in the Developer Manual.
Installation
Proxeus is primarily a Web application, intended for access with a web browser. The Proxeus Association maintains a demo instances you can use to test the product, and can recommend a service provider to help you or your business get set up. There is also a prototype desktop application.
In addition to the developer guidelines below, several "one-click" deployment configurations are available for select cloud platforms:
Currently supported Blockchains include:
- Ethereum: mainnet, sepolia, goerli
- Polygon: mainnet, mumbai
If you wish to build the project from source code, follow the instructions in Build all.
Join the Discussions if you have any questions.
Contributing
As an open-source project, we welcome any kind of community involvement, whether that is by contributing code, reporting issues or engaging in insightful discussions. Especially, we are looking forward to receiving contributions for external workflow nodes.
Please read the Developer Manual to learn more about developing on the Proxeus platform.
See the Contributing Guide for further directions.
Security Issues
If you find a vulnerability that may affect live or testnet deployments please DO NOT file a public issue - send your report privately to info@proxeus.org
License
Licensed under the GNU GENERAL PUBLIC LICENSE. You may read a copy of the License here.
Acknowledgements
Like so many projects, this effort has roots in many places. The list can be found in ACKNOWLEDGEMENTS.
Directories
¶
| Path | Synopsis |
|---|---|
|
handlers/blockchain/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
Package service holds the service layer for the Proxeus core
|
Package service holds the service layer for the Proxeus core |
|
Package storage holds the storage layer for the Proxeus core
|
Package storage holds the storage layer for the Proxeus core |
|
database/db
Package db holds the database layer for the Proxeus core
|
Package db holds the database layer for the Proxeus core |
|
database/mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
mock
Package mock is a generated GoMock package.
|
Package mock is a generated GoMock package. |
|
file
This package simplifies file IO and handles the file path when using JSON or MSGPACK.
|
This package simplifies file IO and handles the file path when using JSON or MSGPACK. |