Skip to content
master
Go to file
Code
This branch is 2811 commits ahead, 33 commits behind valnet:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
cmd
 
 
 
 
 
 
 
 
 
 
 
 
 
 
ocp
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Open Collaborative Platform

OCP is a collective economic management platform, based on the REA accounting model (Resource-Event-Agent), which allows for a common 'economic facts tracking system' shared among various projects and users operating on the platform as economic Agents. Accounting for all kinds of resources (in this multi-context system) supports the implementation of a more ethical and efficient economic system. Transactions traceability and data retrieval and sharing, for example, not only facilitates management, marketing, or ordinary financial accounting but also other non-accounting policy choices, such as reputation and trust.

OCP was born as a fork from the ValueNetwork NRP by mikorizal (quoting a former README "..something analogous to an ERP system for value networks. Might call it NRP for Network Resource Planning..") back in June 2016 to address the needs of FreedomCoop a FairCoop's toolkit for self-management and accountancy for individuals and groups striving for fairer social and economic relationships*. One of ist features was introducing FairCoin as the main internal currency also used to pay Shares at membership time.

Since then, OCP has been refactored into a multi-context system, where multiple projects with different domains and URLs have a common backend and share a common database with common data (agents, units, resource types, etc.) while maintaining each context its own registration process, payment gateways, active services, e-mail notification servers, and many other features.

FairCoop self-organizing tool to track tasks and distributions (Open Collaborative Work) used OCP as backend for Agent, React frontend, based also on the ValueFlows vocabulary.

Bank of the Commons, a huge cooperative banking project launched on June 2017, adopted OCP for the whole membership process and shares system. To meet their needs some payment gateways have been implemented ad-hoc and also the 'multicurrency' app that allows each user to create/access their BotC multi-wallet from the OCP.

Features

  • Multi-language platform (static texts)

  • Multi-language international projects (dynamic db texts):

    • Translatable agent fields: name, nickname, email, website, address, description, phone and image url.
    • Translatable agent's relation type fields: name, plural name, label and inverse label.
    • Translatable resource type fields: name and description.
    • Translatable agent-resource role name field.
  • Custom register form fields and texts for each project (using fobi).

  • Custom register joining style per project:

    • 'autojoin' (for internal projects, just click to join, no moderation)
    • 'moderated' (review and communication for each candidature, needs custom fobi form)
    • 'shares' (moderated but involving project's shares and payment gateways)
    • 'subscription' (still WIP)
  • Custom project visibility: public, private or FCmembers

  • Custom membership workflow boolean option for moderated projects:

    • Auto create user+agent and send confirmation email: to review manually the spam registers before even sending the confirm email (with a usable password) leave unchecked. To speedup the process if you don't expect much spam, check it.
  • Custom domain URLs configurable for each main project context to access OCP.

  • Custom login and register texts for each main project.

  • Custom CSS, Javascript and background image for each main project.

  • Custom active services per main project, the options are:

    • faircoins (enables the internal faircoin wallet connection)
    • multicurrency (enables the BotC wallet connection)
    • projects (allows project's members to manage other projects in OCP)
    • shares (enables the project's custom shares management)
    • exchanges (enables the 'exchanges' view of the economic transfers)
    • skills (enables skills management for project's members)
    • tasks (enables the tasks system for members)
    • processes (enables the plan/process system for members)
  • Custom Share definition and value per project (if needed):

    • Share's name, shortname, value-unit (Eur, Fair, Btc, etc) and unit-value (share's price).
  • Custom Payment gateways per project (to pay their shares):

    • Bank Transfer, or any manual confirmation option.
    • Faircoin using the internal server wallet to pay from the user's fair-account to the project's account (auto confirms on pay).
    • Faircoin using the BotC multi-wallet (to confirm payments the coordinators must put the corresponding BotC-Wallet transaction ID and the received amount).
    • Faircoin using an external project's fair-account (to confirm payments the coordinators must put the corresponding blockchain tx hash and the exact received amount).
    • BTC or ETH using an external project's btc or eth account (to confirm payments the coordinators must put the corresponding blockchain tx hash and the exact received amount).
    • CreditCard synchronous gateway was ready using the Fairbill processor service, and it autoconfirmed the payments correctly but has never been used in production yet.
  • Join Requests page for project's coordinators to manage the candidatures:

    • Fast page load for big projects, using ajax pagination with DataTables.
    • Easy buttons that appear in each row when needed to:
      • send the confirmation email (with the user initial random password) if is pending,
      • delete all (request, user and agent) when email not confirmed for a long time,
      • go to the feedback page with the candidate (shows nº of comments),
      • go to the exchange page related the shares purchase (or set as pending if the exchange is missing),
      • accept the member, if shares it shows-up when paid (will activate the member access to the project's offered tools)
      • decline the candidature (inactivates the member access to the project's tools),
  • Feedback page related any moderated membership process with any project. it shows:

    • The data entered by the user in the project's register form.

    • The custom form fields of any candidate's join-request answers can be edited by the coordinators of the project (just click on them).

    • If shares, to help the candidate to do the payment depending on her/his chosen payment gateway:

      • if chosen Faircoin from the internal faircoin wallet accounts, a button to pay appears if enough balance, or useful warning info instead.
      • if chosen bank Transfer or any manual option, the details to pay are shown. Coordinators can manually confirm the payment to set up the exchange as complete.
      • if chosen other Cryptos using external accounts, the info to pay is shown for candidates. Coordinators will need to input the blockchain transaction hash and the exact received amount (9 decimals).
      • if chosen Faircoin from the BotC-Wallet account: if the candidate has filled-up a special 'multicurrency username' field in the register form, the multicurrency Connect button appears, otherwise a 'Create Multicurrency Account' button appears. If the actual balance of faircoin in the user's BotC account is enough to pay the shares, a button to directly pay the shares is shown, but it is still disabled due missing changes in the BotC-Wallet software to have enough security for that API call and response.
    • The communication thread of messages between coordinators and members/candidates (with email notification).

  • Exchanges page to represent each agent economic activity related to other agents (buys/sells of resources or services, etc), with:

    • a flexible multi-unit Totals box, which shows actual balances and also committed future balances, related the commitments in the exchanges related to the user. The calculated balances are now cached to gain speed on page load.
    • a simplified Filters box, which filters by dates range, by state and by types, now all via ajax (without reloading the page).
    • a fast paginated ajax list of Exchanges, representing in each row the main information useful for the user, showing both transfers of any exchange (except for donations, which has one transfer), using the js DataTables plugin.
  • Many more features (somewhat unattended lately) inherited from the original valuenetwork: Simple tasks and process tasks, plan a process with or without using known 'recipes', value equations and distributions, etc. The discontinued 'Agent' react frontend was solving better those features.

Built With

Release v1.0.0

  • Python 3.7 compatible, works with Django 2.0 (see other updates in 'requirements.txt')
  • It uses the NPM build system to work from scss files (still only used by the new pinax template)
  • jQuery 3.3, Bootstrap 4.0, and other updates seen in package.json

Fixes

  • Fixed the speed issues for coordinators of large projects, by post-loading of data via ajax paginated chunks, in the most critical management pages:
    • the Join Requests list page
    • the Project's page, now the Relations box will load users in the lists only if you open them, and by small chunks.
    • the Exchanges list page
  • Fixed the unit tests to re-enable the Travis-CI green check:
    • The selenium tests are working again with a particular chromedriver version (see note).
    • The API tests were repaired by refactoring to Python3, Graphql2, upgrading graphene, etc.
  • Fixed many Responsive issues, now is usable from small devices.
  • Fixed the main Install doc and other docs (at /docs) and this Readme.

Installation

To get a local copy up and running follow these simple steps: INSTALL

Use Cases

Some working URLs using the actual OCP platform instances are:

Documentation

see new howtos together with others released in the past in both ../docs and here amongst them a bit of Bank of the Commons OCP History.

Roadmap of the Dev Team

  • Maintenance and stabilization of OCP 1.x version by fixing any found bug and improve overall usability for the main projects using the platform. Clean old unused code and better self-document the code in-place.

  • Find ways to keep funding the maintenance and features development.

  • Find ways to involve more developers.

  • Find ways to increase the early testers team and the overall community around the software.

  • Finish the recurring payments 'subscription' model membership workflow.

  • Milestone #1: Create a new React Frontend learning from the Shroom and the Agent React experiences to allow:

    • an easy input of user Needs, starting with Food needs, and
    • easy input of user offered Food products for producers and consumer groups.
    • this frontend will be initially connected to the OCP as a backend but will be also useful for the future CommonDB distributed data network backend.
  • Milestone #2: Port all the actual membership and exchanges functionality to the new react frontend, at least for regular members.

  • Other possible milestones:

    • Port to the new React frontend:
      • all other OCP features (faircoins, multicurrency, skills, tasks and process, etc)
      • port also the project's coordinators pages and tools
    • In the case a multi-wallet service is needed, with enough team and funds, it's doable in OCP:
      • build a BTC and an ETH wallets in the OCP server and connect each user with a crypto account, the same procedure used with Faircoin wallet, to allow direct multicurrency from OCP internally.

Contributing contributions welcome

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Contributors

see Contributors.txt

License

License: GPL v3

Contact

Gitter

Acknowledgements

You can’t perform that action at this time.