Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jhwohlgemuth/applied

Applied mathematics toolkit implemented in JavaScript
https://github.com/jhwohlgemuth/applied

applied-mathematics javascript math-library mathematics

Last synced: 2 months ago
JSON representation

Applied mathematics toolkit implemented in JavaScript

Awesome Lists containing this project

README

        


applied.js

> **Applied** mathematics toolkit implemented in **JS** (ECMAScript)

[![npm](https://img.shields.io/npm/v/applied.svg)](https://www.npmjs.com/package/applied)
[![Build Status](https://travis-ci.org/jhwohlgemuth/applied.svg?branch=master)](https://travis-ci.org/jhwohlgemuth/applied)
[![Coverage Status](https://coveralls.io/repos/github/jhwohlgemuth/applied/badge.svg?branch=master)](https://coveralls.io/github/jhwohlgemuth/applied?branch=master)
[![bitHound Overall Score](https://www.bithound.io/github/jhwohlgemuth/applied/badges/score.svg)](https://www.bithound.io/github/jhwohlgemuth/applied)
[![Known Vulnerabilities](https://snyk.io/test/github/jhwohlgemuth/applied/badge.svg)](https://snyk.io/test/github/jhwohlgemuth/applied)

Installation
------------

```bash
npm install applied
```

Usage
-----

> Under construction

Contributing
------------

> **Note:** Linux is the only actively supported OS for development

**Requirements**
- Git
- Node.js ([nvm](https://github.com/creationix/nvm) is suggested)

**Setup**

```bash
git clone [email protected]/jhwohlgemuth/applied.git
cd applied
#Install dependencies
npm install
#Verify applied installed correctly by running tests
npm test
```
**Workflow Tasks**

- `npm test` > run test suite
- `npm run test:watch` > watch task for running tests
- `npm run test:build` > build module and verify that it can be loaded
- `npm run lint` > lint code
- `npm run lint:watch` > watch task for code linting
- `npm run build` > bundle code using browserify
- `npm run docs` > generate and view the documentation

Roadmap
-------

- Follow progress on [Trello](https://trello.com/b/Tjw9CBXd/appliedjs)

Credits
-------
- [Adam Shaver](https://github.com/ashaver) *thought of the name, "applied", and is a constant source of inspiration*
- [Browserify](http://browserify.org/) *module bundling*
- [Babel](https://babeljs.io/) *ES6 transpiling and minification*
- [JSDoc](http://usejsdoc.org/) *documentation generation*
- [minami](https://github.com/Nijikokun/minami) *documentation theme*

License
-------
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fjhwohlgemuth%2Fapplied.svg?type=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fjhwohlgemuth%2Fapplied?ref=badge_large)