This repository contains JavaScript implementations of different famous Computer Science algorithms.
API reference with usage examples available here.
To install all dev dependencies
Call:
npm install
To setup repository with documentation
- Go to the parent directory of the
javascript-algorithmsfolder and call:
git clone https://github.com/mgechev/javascript-algorithms.git javascript-algorithms-docs
- Go to the
javascript-algorithms-docsfolder and change current branch togh-pages:
git checkout gh-pages
Now you can see index.html file in this folder and open it in your browser.
To update .html files with documentation
Go to the javascript-algorithms folder and call:
gulp jsdoc
and all files in javascript-algorithms-docs folder will be updated.
To run tests
Call:
gulp testand all *.spec.js files will be executed.
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:
gulp 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.
| mgechev | AndriiHeonia | Jakehp | lygstate | mik-laj | krzysztof-grzybek |
| pvoznenko | jettcalleja | filipefalcaos | kdamball | lekkas | infusion |
| deniskyashif | designeng | pkerpedjiev | Xuefeng-Zhu | Microfed | alexjoverm |
| amilajack | shaunak1111 | contra | liesislukas | millerrach | fanixk |
| ysharplanguage |
The code in this repository is distributed under the terms of the MIT license.