Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/algos-all/algos-js

Classic CS algos implemented in javascript
https://github.com/algos-all/algos-js

cs-algorithms javascript

Last synced: about 2 months ago
JSON representation

Classic CS algos implemented in javascript

Awesome Lists containing this project

README

        

# Module algos-js

[![Travis](https://img.shields.io/travis/alisianoi/algos-js.svg)](https://travis-ci.org/alisianoi/algos-js)
[![Coveralls](https://img.shields.io/coveralls/alisianoi/algos-js.svg)](https://coveralls.io/github/alisianoi/algos-js)
[![npm](https://img.shields.io/npm/v/algos-js.svg)](https://www.npmjs.com/package/algos-js)
[![license](https://img.shields.io/github/license/alisianoi/algos-js.svg)](https://choosealicense.com/licenses/mit/)

## What is algos-js?

This is a small project that contains several common computer science algorithms. It helps
me both learn JavaScript and practice these algorithms along the way.

The project has a few tests implemented with the [mocha][1] testing framework. Continuous
integration is done with [travis][2] and code coverage is available at [coveralls][3]. The
default package manager is [yarn][6].

## How to install?

### Installing from GitHub

You would need to clone the project with `git` and install its dependencies with `yarn`:

```
git clone https://github.com/alisianoi/algos-js
cd algos-js
yarn install
```

## How to uninstall?

### After installing from GitHub

Remove the folder that you cloned from GitHub:

```
rm -rf algos-js
```

## What algorithms are ready?

## How to test?

To run all the unit tests and produce a coverage report:

```yarn run test```

To run all the unit tests manually without the coverage report:

```./node_modules/mocha/bin/mocha --recursive```

To run unit tests for a specific module:

```./node_modules/mocha/bin/mocha test/test_binsearch.js```

[1]: https://mochajs.org/
[2]: https://travis-ci.org
[3]: https://coveralls.io
[4]: https://git-scm.com/
[5]: https://github.com
[6]: https://yarnpkg.com/