-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from ProxeusApp/preprod
Preprod
- Loading branch information
Showing
3 changed files
with
23 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,37 +2,32 @@ | |
|
|
||
| # Proxeus Core | ||
| ---------------- | ||
| Main repository of the Proxeus core platform. | ||
|
|
||
| Proxeus combines a powerful document automation tool with the wide-ranging | ||
| blockchain functionalities, enabling users to digitize and monetize their IP. | ||
| You can access the source code of this application and various extensions | ||
| on [GitHub](https://github.com/ProxeusApp). | ||
| 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](https://github.com/ProxeusApp). | ||
|
|
||
| ## User guides | ||
|  | ||
|
|
||
| Get help to make the most of the platform in the **[User Handbook](https://github.com/ProxeusApp/community/blob/master/handbook/handbook.md)**. | ||
|
|
||
| For detailed information about payment setup, check the [XES-Payment Readme](docs/xes-payment.md). | ||
| ## User Guides | ||
|
|
||
| To learn more about Smart Contracts, see the documentation in the [Solidity Readme](https://github.com/ProxeusApp/proxeus-contract). | ||
| Get help to make the most of the platform in the **[User Handbook](https://github.com/ProxeusApp/community/blob/master/handbook/handbook.md)**. | ||
|
|
||
| ### Quickstart | ||
| To learn more about Smart Contracts using Solidity, see the documentation in the [proxeus-contract](https://github.com/ProxeusApp/proxeus-contract). | ||
|
|
||
| You can get all the information to run Proxeus here. In addition to the Docker installation documented below, we are making facilitated "one-click" automated build configurations available for select cloud platforms. | ||
| For detailed information about payment setup (currently unsupported), check the [XES-Payment](docs/xes-payment.md) project. | ||
|
|
||
| - [Linode StackScript](deploy/linode/README.md) | ||
| ## Installation | ||
|
|
||
| Please [contact us](https://github.com/ProxeusApp/community/discussions/3) if you are interested in additional providers on this list. | ||
| Proxeus is primarily a Web application, intended for access with a web browser. The [Proxeus Association](https://proxeus.org) 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](https://github.com/ProxeusApp/storage-app/blob/master/docs/overview.md). | ||
|
|
||
| ### Contributing | ||
| In addition to the developer guidelines below, several "one-click" deployment configurations are available for select cloud platforms: | ||
|
|
||
| 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. | ||
| - [Docker Compose](docker-compose.yml) | ||
| - [Linode StackScript](deploy/linode/README.md) | ||
| - [DigitalOcean Droplet](deploy/digitalocean/README.md) | ||
|
|
||
| See the **[Contributing Guide](docs/contributing.md)** for further directions. | ||
| Please [contact us](https://github.com/ProxeusApp/community/discussions/3) if you are interested in seeing additional providers on this list. | ||
|
|
||
| ## Development guide | ||
| ## Development | ||
|
|
||
| Please read the [Developer Manual](https://doc.proxeus.com) to learn more about the Proxeus platform. | ||
|
|
||
|
|
@@ -58,6 +53,13 @@ Please note that the domain you set up on SparkPost MUST match the **reply-to** | |
|
|
||
| If all goes well, Proxeus should be available at http://localhost:1323. The next step will be to [configure](docs/configure.md) your instance for the first time. | ||
|
|
||
| ## 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. | ||
|
|
||
| See the **[Contributing Guide](docs/contributing.md)** 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 [email protected] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters