plasma-utils is the set of core utilities for the Plasma Group series of projects.
These utilities can be imported into other projects when necessary or convenient.
Detailed documentation for
plasma-utils is available on ReadTheDocs: https://plasma-utils.readthedocs.io/en/latest/.
There are several easy ways to start using
If you're developing a
Node.js application, you can simply install
$ npm install --save plasma-utils
If you're developing a browser application, we provide a compressed and minified version of
plasma-utils that you can include in a
Welcome! If you're looking to contribute to
plasma-utils, you're in the right place.
Contributing Guide and CoC
Plasma Group follows a Contributing Guide and Code of Conduct adapted slightly from the Contributor Covenant. All contributors are expected to read through this guide. We're here to cultivate a welcoming and inclusive contributing environment, and every new contributor needs to do their part to uphold our community standards.
Requirements and Setup
Cloning the Repo
Before you start working on
plasma-utils, you'll need to clone our GitHub repository:
git clone firstname.lastname@example.org:plasma-group/plasma-utils.git
Now, enter the repository.
plasma-utils is tested and built with
Although you do not need [
Node.js] to use this library in your application, you'll need to install
Node.js (and it's corresponding package manager,
npm) for your system before contributing.
We've provided a detailed explanation of now to install
Node.js on Windows, Mac, and Linux.
plasma-utils has been tested on the following versions of Node:
If you're having trouble getting a component of
plasma-utils running, please try installing one of the above versions of
Node.js and try again.
It's pretty easy to switch
Node.js versions using
npm install -g n
Next, install your desired verson of
plasma-utils makes use of several
Install all required packages with:
$ npm install
Run all tests with:
$ npm test
gulp to provide a process to build
plasma-utils for in-browser usage.
If you'd like to build
plasma-utils yourself, simply run:
$ npm run build