Skip to content

neuralinterfaces/commoners

Repository files navigation

Commoners

Npm package version Npm package monthly downloads

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

  • Commoners Starter Kit — A template Commoners app with all the bells and whistles.
  • tqdm.me — View your tqdm progress bars anywhere.
  • 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!

Local Development

Use npm i to install all dependencies into the monorepo's workspaces.

Core

Testing

Before testing, you'll have to run npm run build in the root directory.

CLI

To get started with the CLI, you'll need to use npm link to connect it with the @commoners/solidarity package in packages/core:

cd packages/core
npm link
cd ../cli
npm link @commoners/solidarity

You'll only have to do this once.

After this, you can then install commoners globally from the packages/cli directory:

npm install -g .

Acknowledgements

This project is part of Neural Interfaces.

About

The Cross-Platform Framework for the Web

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published