At the moment, the polyPod is essentially a runtime for features; small, sandboxed JavaScript applications that can be launched from the polyPod app.

But it will be much more than that. For more information please read the polyPod whitepaper.

• android: The polyPod app for Android
• ios: The polyPod app for iOS
• podjs: A polyPod implementation that runs in a regular browser
• features: polyPod features
• core: The polyPod core modules
• build: The build logic

Just Node.js version 16.x or newer.

Just execute:

$ ./build.js

This will build the cross platform code base - mainly the core code and bundled features.

After this you can build android, ios, or try one of the features, e.g. features/example.

(Yes, we have a custom build script, you can read more about why here if you're curious.)

To run the tests, just execute:

$ ./build.js test

To run the linter:

$ ./build.js lint

Please note that this won't trigger tests or linting for non-JS code, for example android.

If linting reveals some error, they can be fixed with

$ ./build.js lintfix

Ongoing development is happening in the main branch. We aim to keep it stable at all times, but it is not as thoroughly tested as our releases. This is the branch to make contributions against.

We prepare releases in the release branch. If no release is in progress, it reflects the state of the last release we made.

Please read the SECURITY document on how to report potential security vulnerabilities in polyPod and where to find polypoly's Vulnerability Disclosure Policy.

Please see CONTRIBUTING.md.

Copyright © 2021 pc polypoly coop SCE mbH

Licensed under the GNU General Public License, Version 3. Please see the LICENSE document for details and a copy of the license.

License information of 3rd party components is available in the 3rd-party-licenses/ directory.

• polypoly® is a registered trademark of polypoly Enterprise GmbH
• polyPod is a trademark in registration of pc polypoly coop SCE mbH
• polyPedia is a trademark in registration of polypoly Foundation gGmbH