Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marcbperez/js-algorithms
Algorithms implemented in JS.
https://github.com/marcbperez/js-algorithms
algorithms docker gradle javascript
Last synced: about 7 hours ago
JSON representation
Algorithms implemented in JS.
- Host: GitHub
- URL: https://github.com/marcbperez/js-algorithms
- Owner: marcbperez
- License: apache-2.0
- Created: 2017-03-06T19:57:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-11-18T12:05:01.000Z (about 4 years ago)
- Last Synced: 2024-10-20T00:35:44.692Z (about 1 month ago)
- Topics: algorithms, docker, gradle, javascript
- Language: JavaScript
- Homepage:
- Size: 73.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# js-algorithms
A set of common algorithms implemented in JS. Includes binary search, selection
and insertion sort, merge sort, quicksort and breadth-first search.
## Installation
Start by downloading and building the project when necessary. The following
commands will do the job on most Debian based Linux distributions.
```bash
git clone https://github.com/marcbperez/js-algorithms
cd js-algorithms
```
## Usage
The examples can be used from the command-line with Node.js.
```bash
node src/binary-search.js
```
They can also be embedded in other modules.
```javascript
var algorithms = require('js-algorithms/src/binary-search.js');
console.log(algorithms.binarySearch(primes, 53));
```
Or included in an HTML document.
```html
console.log(binarySearch(primes, 53));
```
## Testing
Test checks are executed automatically every time the project is built. Builds
can be done remotely or continuously on a development context. For continuous
integration and development use docker-compose. This is recommended to keep the
system clean while the project is built every time the sources change.
```bash
sudo docker-compose up
```
For continuous integration and development without any dependencies use the
Gradle wrapper. This is the best option if the wrapper is available and the
Docker context is not valid. For a full list of tasks, see
`sudo ./gradlew tasks --all`. For a CI cycle use `sudo ./gradlew --continuous`.
For continuous integration and development without Docker or the project wrapper
use Gradle directly. This will create the wrapper in case it is not present.
Similar to the above, for a CI cycle use `sudo gradle --continuous`. Gradle
3.4.1 is required for this to work. Plain Docker is also available for remote
integration tasks and alike. Build the image with `sudo docker build .` and run
a new container with it. Information on how to install Docker and docker-compose
can be found in their [official page][install-docker-compose]. A similar
installation guide is available [for Gradle][install-gradle].
## Troubleshooting
The [issue tracker][issue-tracker] intends to manage and compile bugs,
enhancements, proposals and tasks. Reading through its material or reporting to
its contributors via the platform is strongly recommended.
## Contributing
This project adheres to [Semantic Versioning][semver] and to certain syntax
conventions defined in [.editorconfig][editorconfig]. To get a list of changes
refer to the [CHANGELOG][changelog]. Only branches prefixed by *feature-*,
*hotfix-*, or *release-* will be considered:
- Fork the project.
- Create your new branch: `git checkout -b feature-my-feature develop`
- Commit your changes: `git commit -am 'Added my new feature.'`
- Push the branch: `git push origin feature-my-feature`
- Submit a pull request.
## Credits
This project is created by [marcbperez][author] and maintained by its
[author][author] and contributors.
## License
This project is licensed under the [Apache License Version 2.0][license].
[author]: https://marcbperez.github.io
[issue-tracker]: https://github.com/marcbperez/js-algorithms/issues
[editorconfig]: .editorconfig
[changelog]: CHANGELOG.md
[license]: LICENSE
[semver]: http://semver.org
[install-docker-compose]: https://docs.docker.com/compose/install/
[install-gradle]: https://gradle.org/install