Applied mathematics toolkit implemented in JS (ECMAScript)

Installation

npm install applied

Usage

Under construction

Contributing

Note: Linux is the only actively supported OS for development

Requirements

• Git
• Node.js (nvm is suggested)

Setup

git clone git@github.com/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

Credits

• Adam Shaver thought of the name, "applied", and is a constant source of inspiration
• Browserify module bundling
• Babel ES6 transpiling and minification
• JSDoc documentation generation
• minami documentation theme

License