Commoners

The commoners CLI allows anyone to build their application as a Progressive Web App (PWA); Mac, Windows, and Linux desktop application; and iOS and Android mobile application—all using only HTML, CSS, and JavaScript.

Read the documentation to learn more.

Key Projects

• Brains@Play — A multi-platform application for accessing neural data.

Build Solidarity

At the heart of Commoners is our belief that everyone should be able to write an application using HTML, CSS, and JavaScript for distribution on all platforms.

We use the term build solidarity to indicate the alignment of the world's web developers on a consistent architecture to achieve this goal.

Let's build solidarity together!

Packages

Package	Latest Release
commoners
@commoners/solidarity
@commoners/testing

Plugins

Package	Latest Release
@commoners/bluetooth
@commoners/serial

Contributing

You will need to have Node.js installed on your machine.

This repository uses PNPM for package management. Install PNPM by running the following command:

npm install -g pnpm

Install all packages by running the following command:

pnpm install

Finally, build all packages by running:

pnpm build

Testing

Initial Setup

conda env create -f tests/demo/src/services/python/environment.yml

Running Tests

Always run tests with the commoners-test-app environment activated.

conda activate commoners-test-app

You must also ensure that g++ is available to build the C++ server.

Then, simply run the following command:

pnpm test

Linux

When running tests on Linux, you'll need to install FUSE for AppImage support:

sudo apt-get update && sudo apt-get install -y fuse

Acknowledgements

This project is part of Neural Interfaces.