About
This repository contains JavaScript implementations of different famous Computer Science algorithms.
API reference with usage examples available here.
Development
To install all dev dependencies
Call:
npm install
To setup repository with documentation
npm run doc
This will build the documentation and open it in your browser.
To update .html files with documentation
Just run npm run doc
again.
To run tests
Call:
npm run test
and all *.spec.js
files will be executed.
To deploy documentation site
npm run deploy
This requires you to have commit access to your Git remote.
Contributions
Fork the repo and make required changes. After that push your changes in branch, which is named according to the changes you did. Initiate the PR.
Make sure you're editor makes validations according to the .jshintrc
in the root directory of the repository.
Before pushing to the repository run:
npm run build
If the build is not successful fix your code in order the tests and jshint validation to run successfully and after that create a pull request.
Contributors
mgechev | AndriiHeonia | Jakehp | lygstate | mik-laj | jeremyckahn |
krzysztof-grzybek | pvoznenko | jettcalleja | kdamball | lekkas | infusion |
deniskyashif | filipefalcaos | brunohadlich | designeng | Microfed | pkerpedjiev |
Xuefeng-Zhu | emyarod | liesislukas | alexjoverm | BorislavBorisov22 | ysharplanguage |
jurassix | contra | amilajack | millerrach | xiedezhuo | DengYiping |
fanixk | miyes90 | shaunak1111 |
License
The code in this repository is distributed under the terms of the MIT license.