@chialab/proteins

A primer for JavaScript libraries and frameworks development.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
71May 25, 2021May 10, 2017Minified + gzip package size for @chialab/proteins in KB

Readme

Proteins logo

Proteins • A primer for JavaScript libraries and frameworks development.

NPM


Install

Add as a dependency of a Node project:

$ npm install @chialab/proteins
# or
$ yarn add @chialab/proteins

Use via cdn:

<script type="text/javascript" src="https://unpkg.com/@chialab/proteins"></script>

Development

Build status codecov

Sauce Test Status

Requirements

In order to build and test Proteins, the following requirements are needed:

Build the project

Install the dependencies and run the build script:

$ yarn install
$ yarn build

This will generate the UMD and ESM bundles in the dist folder, as well as the declaration file.

Test the project

Run the test script:

$ yarn test

License

Proteins is released under the MIT license.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.