https://github.com/chialab/proteins

A primer for JavaScript libraries and frameworks development.
https://github.com/chialab/proteins

Last synced: about 2 months ago
JSON representation

A primer for JavaScript libraries and frameworks development.

• Host: GitHub
• URL: https://github.com/chialab/proteins
• Owner: chialab
• License: mit
• Created: 2017-05-10T07:01:41.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-16T15:54:15.000Z (9 months ago)
• Last Synced: 2024-11-06T22:51:34.408Z (about 2 months ago)
• Language: JavaScript
• Homepage: https://chialab.github.io/proteins/
• Size: 1.61 MB
• Stars: 7
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    

        

    





  Proteins • A primer for JavaScript libraries and frameworks development.





    



---

## Get the library

Install via NPM or Yarn:

```

npm i @chialab/proteins

```

```

yarn add @chialab/proteins

```

---

## Development

[![Build status](https://github.com/chialab/proteins/workflows/Main/badge.svg)](https://github.com/chialab/proteins/actions?query=workflow%3ABuild)

[![codecov](https://codecov.io/gh/chialab/proteins/branch/main/graph/badge.svg)](https://codecov.io/gh/chialab/proteins)

### Build

Install the dependencies

```

yarn

```

and run the `build` script:

```

yarn build

```

This will generate the ESM and CJS bundles in the `dist` folder and declaration files in the `types` folder.

---

## License

Proteins is released under the [MIT](https://github.com/chialab/proteins/blob/main/LICENSE) license.