MADS (Mathematics, Algorithms, Data Structures) is a set of TypeScript utility modules for working with various mathematical functions, algorithms and data structures.
Note: documentation and examples for each package are published in their respective READMEs. Please, refer to those resources for installation details and API references.
| Package | Version | Dependencies |
|---|---|---|
mads-constants |
 |
 |
mads-coordinates |
 |
 |
mads-easing |
 |
 |
mads-graph |
 |
 |
mads-utils |
 |
 |
mads-vec2 |
 |
 |
mads-vec3 |
 |
 |
mads-queue |
 |
 |
mads-stack |
 |
 |
mads-heap |
 |
 |
We have prepared multiple commands to help you develop mads on your own. You will need a local copy of Node.js installed on your machine. Then, follow the steps bellow:
-
Install
lernaglobally:$ npm install -g lerna
-
Install project dependencies:
$ npm install
-
Install packages dependencies and link them together:
$ npm run bootstrap
$ npm run <command>| Command | Description |
|---|---|
bootstrap |
Links local packages together and install their dependencies. |
build |
Builds all packages. |
docs |
Builds documentation for all packages. |
start |
Starts tests in watch mode for all packages. |
test |
Alias for npm run test:unit and npm run test:lint. |
test:unit |
Starts units tests for all packages. |
test:lint |
Starts linters for all packages. |
We use Hygen to create new ready-to-develop packages for MADS. If you want to automatically create a new package, run the following command and follow the prompt tips:
$ npx hygen package newMADS was created and developed by Bartosz Łaniewski. The full list of contributors can be found here. Each package is MIT licensed, except for packages that provide a different LICENSE file.
We want contributing to MADS to be fun, enjoyable, and educational for anyone, and everyone. Changes and improvements are more than welcome! Feel free to fork and open a pull request. If you have found any issues, please report them here - they are being tracked on GitHub Issues.