mgechev / Javascript Algorithms

About

This repository contains JavaScript implementations of 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

This will execute all *.spec.js files.

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. Afterwards, push your changes in branch. The name will be according to the changes you did. Initiate the pull request.

Make sure your 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 for the tests and jshint validation to run successfully. Then create a pull request.

Contributors

mgechev	AndriiHeonia	Jakehp	lygstate	mik-laj	krzysztof-grzybek

pvoznenko	jettcalleja	filipefalcaos	kdamball	lekkas	infusion

deniskyashif	brunohadlich	designeng	Microfed	Nirajkashyap	pkerpedjiev

duffman85	Xuefeng-Zhu	emyarod	alexjoverm	amilajack	BorislavBorisov22

brunob15	BryanChan777	ysharplanguage	jurassix	fisenkodv	contra

liesislukas	marrcelo	wnvko	millerrach	xiedezhuo	DengYiping

fanixk	wlx199x	shaunak1111

License

The code in this repository is distributed under the terms of the MIT license.