This repository contains JavaScript implementations of different famous Computer Science algorithms.
API reference with usage examples available here.
Note: not all algorithms are well tested so bugs are quite possible.
To install all dev dependencies
Call:
npm install
To setup repository with documentation
- go to the parent directory of the
javascript-algorithms
folder and call:
git clone git@github.com:mgechev/javascript-algorithms.git javascript-algorithms-docs
- go to the
javascript-algorithms-docs
folder 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
You should install jasmine-node
:
npm install -g jasmine-node
Call:
jasmine-node test/
and all *.spec.js
files will be executed.
Fork the repo and make requred changes. After that push your changes in branch, which is named according to the changes you did. Initiate the PR.
The code in this repository is distributed under the terms of the MIT license.