diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 000000000..0f10053c8 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,13 @@ +version: 2 +updates: + # Maintain dependencies for Go + - package-ecosystem: "gomod" + directory: "/" + schedule: + interval: "weekly" + + # Maintain dependencies for JS + - package-ecosystem: "npm" + directory: "/ui/" + schedule: + interval: "weekly" diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 58ec094bf..b12d77994 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,8 +1,11 @@ ![logo](_media/proxeus_logo.svg) -# 1.0.0 -> Blockchain-enabled documents and workflows +> Your data. Your blockchain. Your business. -Proxeus combines a powerful document automation tool with the wide-ranging blockchain functionalities, enabling users to digitize and monetize their IP. +### Open source form builder, workflow designer, and document validation. + +Proxeus combines a versatile document automation tool with enterprise
blockchain functionalities, enabling users to more easily digitize their IP. [Getting Started](quickstart.md) +[Community Forum](https://github.com/ProxeusApp/community/discussions) + diff --git a/docs/_navbar.md b/docs/_navbar.md index 89ff8b160..4eb12a294 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -1,4 +1,4 @@ +* [Association](about.md) * [Quick start](quickstart.md) * [Configure](configure.md) * [Deploy](components.md) -* [Source Code](source_code.md) diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 000000000..d3e47ce11 --- /dev/null +++ b/docs/about.md @@ -0,0 +1,216 @@ +# The Proxeus Association + +The association is the governing body responsible for the maintenance and development of the Proxeus software. We also aim to encourage innovation and evangelize the project by launching and supporting community initiatives as well as creating synergies and partnerships with relevant community projects. The Association is working to give the project a decentralized structure (DAO) to allow our members to propose guidance on the software. We want to make the Proxeus software the WordPress of the blockchain and democratize the development of blockchain applications. + +Please visit our [Community Forum](https://github.com/ProxeusApp/community/discussions) if you have any questions about the project, or write to us at association@proxeus.org + +Articles of association +----------------------- + +Proxeus Association is a non-profit association governed by the present statutes and, secondly, by Articles 60 et seq. of the Swiss Civil Code. It is politically neutral, and non- denominational. + +OVERVIEW +-------- + +### Article 2 + +- Legal Seat: The Association's headquarters are located in Berne, Canton of Berne. + +- Duration: The Association shall be of unlimited duration. + +GOALS +----- + +### Article 3 + +The Proxeus software is a powerful workflow engine with blockchain capabilities designed to cover a large spectrum of applications. It is made available as open source code and maintained by a community of users. + +- The Association shall pursue the following goals: + +- set up a governance mechanism for the Proxeus project; + +- allocate resources to maintainers and developers of the Proxeus open source software; and + +- foster innovation and evangelize the project by launching and supporting community initiatives, as well as by creating synergies and partnering with relevant community- driven projects. + +RESOURCES +--------- + +### Article 4 + +The Association's resources are derived from: + +- donations and legacies; + +- sponsorship; + +- public subsidies; + +- membership fees; + +- any other resources authorized by the law. + +- The funds shall be used in accordance with the goals of the Association. + +MEMBERS +------- + +### Article 5 + +Members of the Association: Initially, the founders shall be the only members of the Association. The General Assembly may define further types of membership and how new members of the Association are accepted. + +Membership Fee: Initially, there shall be no membership fees for members of the Association. Later, it is up to the General Assembly to resolve on the introduction of membership fees and to determine the amount owed by the members. + +Termination of Membership: + +Membership terminates: + +- By written resignation thereby notifying the Executive Board (Art. 14) at least three (3) months before the end of the financial year; + +- By exclusion ordered by the Executive Board for just cause (e.g. non-payment of membership fees or damaging the interests of the Association) with no right of appeal to the General Assembly. + +- Upon death / bankruptcy / liquidation of a member. In all cases of termination, the membership fee (if applicable) for the current year remains due. Members who have resigned or who are excluded have no rights to any part of the Association's assets. No financial liability of Members: Only the Association's assets may be used for obligations/commitments contracted in its name. Members have no personal liability whatsoever. + +ORGANS +------ + +### Article 6 + +The Association shall include the following organs: + +- General Assembly + +- Executive Board + +GENERAL ASSEMBLY +---------------- + +### Article 7 + +Composition: The General Assembly is the Association's supreme authority. It is composed of all members. + +Meetings: The General Assembly shall hold an Ordinary Meeting once each year. It may also hold Extraordinary Meetings whenever necessary, at the request of the Executive Board or at least of one-fifth of its members. + +Invitation to Meetings: The Executive Board shall inform the members in writing of the date and place of the General Assembly at least six (6) weeks in advance (email or announcement on the website of Proxeus is sufficient). A detailed notification (email is sufficient), including the proposed agenda, shall be sent to each member at least ten (10) days prior to the date of the meeting. Requests of members to include topics in the agenda must be submitted to the Executive Board prior to the General Assembly. + +No Minimal Attendance Requirement: The General Assembly shall be considered valid regardless of the number of members present. + +### Article 8 + +Responsibilities of the General Assembly: The General Assembly: + +Appoints the members of the Executive Board and elects, at a minimum, the President, the Secretary and the Treasurer; + +- Notes the contents of the reports and financial statements for the year and votes on their adoption; + +- Approves the annual budget; + +- Supervises the activity of other organs, which it may dismiss, stating the grounds therefore; + +- Appoints an auditor for the Organization's accounts (if needed); + +- Handling of any exclusion processes; + +- Decides on any modification of statutes; and + +- Decides on the dissolution of the Association. + +### Article 9 + +President of the General Assembly: The General Assembly is presided over by the President. In absence of the President, the General Assembly is presided over by the Vice President or any other member of the Executive Board as determined by the General Assembly. + +Proposal of President: The President must be proposed by the Executive Board and acts as both President as well as President of the Executive Board. + +### Article 10 + +Resolutions: Decisions of the General Assembly shall be taken by a majority vote of the members present. In case of deadlock, the President, or in his absence the presiding member, shall have the casting vote. + +Resolutions to Amend the Statutes: Decisions concerning the amendment of the Statutes and the dissolution of the Association must be approved by a two-third majority of the members present. + +### Article 11 + +Voting in the General Assembly: Votes are shown by hands or by electronic means made available by the Executive Board, which do not require physical presence of the member at the General Assembly. If at least the majority of the members request it, voting may take place secretly. + +### Article 12 + +Agenda of Ordinary Meeting: The agenda of the Ordinary Meeting of the General Assembly must include: + +- Approval of the Minutes of the previous General Assembly; + +- Approval of the Executive Board's annual Activity Report; + +- Approval of the statement of the Treasurer + +- Setting of membership fees (if membership fees are introduced); + +- Approval of the budget; + +- Approval of reports and accounts; + +- Election of Executive Board members; and + +- Miscellaneous business. + +EXECUTIVE BOARD +--------------- + +### Article 13 + +Responsibilities of the Executive Board: The Executive Board is authorized to carry out all acts that further the purposes of the Association which have not been allocated to the General Assembly. It has the most extensive powers to manage the Association's day-to-day affairs. + +Composition of Executive Board: The Executive Board will be composed of a minimum of two (2) and a maximum of five (5) members and will be elected by the General Assembly for a one-year period. Seeking re-election is permissible. The Executive Board is self-constituted. Quorum: The Executive Board has a quorum when at least two (2) members are present. Upon motion of the President or on request of a member of the Executive Board, the Executive Board will convene. + +Vacancies: If an Executive Board position is vacated the Executive Board will fill the resulting vacancy. The appointment shall be approved by the General Assembly at their next meeting. Responsibility of President: The President of the Association also presides the Executive Board. + +### Article 14 + +Compensation: The Executive Board members may be reasonably compensated for their work on the Executive Board with a fixed annual compensation. The General Assembly determines the compensation for the Executive Board members, if any. Expenses (actual expenses and travel costs proven by digital receipts) incurred by the Executive Board members shall be reimbursed by the Association. + +### Article 15 + +Function of Executive Board: The functions of the Executive Board are: + +- to take the appropriate measures to achieve the goals of the Association; + +- to convene the Ordinary and Extraordinary Meetings of the General Assembly; + +- to take decisions with regard to the policies for the admission of new members as well as the resignation and possible expulsion of members; + +- to ensure that Statutes are applied, to draft rules of procedure, and to administer the assets of the Association. + +### Article 16 + +Legal requirement to elect Auditors: The Auditors have to be elected by the General Assembly. Following the legal rules in Switzerland, the Association must have its accounting audited in the event that two of the criteria listed below are exceeded: + +1. Balance sheet total of CHF 10 million + +2. Turnover of CHF 20 million + +3. 50 full time employees on yearly average + +Voluntary election of Auditors: The General Assembly may, with a two-thirds majority, request the election of an auditor for a limited audit of the accounting even if the above criteria are not met. Responsibilities of Auditors: The auditor shall check the operating and annual accounts prepared by the Executive Board and present a written and detailed report to the General Assembly. + +VARIOUS PROVISIONS +------------------ + +### Article 17 + +Financial year: The financial year shall begin on 1 January and end on 31 December of each year. The first year ends on December 31 2020. + +### Article 18 + +Distribution of assets in case of dissolution: Should the Association be dissolved, all available assets should be transferred to a non-profit organization based in Switzerland pursuing public interest goals similar to those of the Association and likewise benefiting from tax exemption. + +The present Statutes have been approved by the General Assembly of 23 March 2020. For Proxeus Association + +0x77b48b1172a5E37bC46aaC270D582d36dDB92594 + +Oleg Lavrovsky, President + +0xb8012Acd96f92a57207B89573507be1961D48cDA + +Fabian MoĢˆsli, Secretary + +0x88d2235B15Fb8d0217Fd46ef154766a5D5E4F086 + +Vivien Fuhrer, Treasurer \ No newline at end of file diff --git a/docs/build_all.md b/docs/build_all.md index c8993202a..66cd391c6 100644 --- a/docs/build_all.md +++ b/docs/build_all.md @@ -73,11 +73,6 @@ To initialize dependencies run: make init ``` -To update go dependencies run: -``` -make update -``` - The make all command build the `server` and `ui`: ``` make all @@ -85,14 +80,15 @@ make all ### Start -Run `server`. +To run the server (`artifacts/proxeus`): + ``` -./artifacts/proxeus +make run ``` -The platform will be available at the following URL: http://localhost:1323 +The platform should in a few moments be available at the following URL: http://localhost:1323 -It is now time to [configure your platform](configure.md) +It is now time to [configure your platform](configure.md). ### Tips @@ -104,3 +100,5 @@ Update command failing? Try: `go clean -cache -modcache -i -r` - checking your dependency graph to isolate the issue: `go mod graph` +- updating Go & JS dependencies: +`make update` diff --git a/docs/faq.md b/docs/faq.md index a8049b8db..e2d96523c 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,6 @@ # FAQ +To see new tips from the community, or if you have other questions, please visit our [Community Discussions](https://github.com/orgs/ProxeusApp/discussions). ## Installation diff --git a/docs/index.html b/docs/index.html index e7fc9cba8..ed4917017 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - Document + Proxeus.org diff --git a/docs/quickstart.md b/docs/quickstart.md index 9ad42badf..832d94606 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -2,12 +2,17 @@ A brief installation guide. Find more details and explanation of the configuration settings in [configure.md](configure.md). -**By installing and using the Proxeus software you agree with the terms of the [Proxeus License Agreement](LICENSE).** +_"Proxeus is a platform for quick and convenient document digitalization, signing, processing, and distribution. It allows users to keep their important documents secure and registered on the blockchain. Proxeus empowers anyone to create blockchain applications and is available for free as an open-source project." --[S-Pro](https://s-pro.io/)_ + + + ## Source Code You can access the source code of this application on the [Proxeus GitHub repository](https://github.com/ProxeusApp). +**By installing and using the Proxeus software you agree with the terms of the [Proxeus License Agreement](LICENSE).** + ## Install docker and docker-compose The quickest way to try Proxeus is to use `docker-compose`. diff --git a/go.sum b/go.sum index 3ad38fa79..163a0fb49 100644 --- a/go.sum +++ b/go.sum @@ -418,4 +418,4 @@ gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= moul.io/http2curl v1.0.1-0.20190925090545-5cd742060b0e h1:C7q+e9M5nggAvWfVg9Nl66kebKeuJlP3FD58V4RR5wo= moul.io/http2curl v1.0.1-0.20190925090545-5cd742060b0e/go.mod h1:nejbQVfXh96n9dSF6cH3Jsk/QI1Z2oEL7sSI2ifXFNA= -rsc.io/tmplfunc v0.0.3 h1:53XFQh69AfOa8Tw0Jm7t+GV7KZhOi6jzsCzTtKbMvzU= \ No newline at end of file +rsc.io/tmplfunc v0.0.3 h1:53XFQh69AfOa8Tw0Jm7t+GV7KZhOi6jzsCzTtKbMvzU=