Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ohbus/algorithms

Algorithms using Java built with Maven for testing using Junit
https://github.com/ohbus/algorithms

algorithms collection hacktoberfest java maven snippets

Last synced: 3 months ago
JSON representation

Algorithms using Java built with Maven for testing using Junit

Host: GitHub
URL: https://github.com/ohbus/algorithms
Owner: ohbus
License: agpl-3.0
Created: 2020-04-29T07:31:10.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2021-03-09T06:51:01.000Z (almost 4 years ago)
Last Synced: 2023-03-04T15:44:01.433Z (almost 2 years ago)
Topics: algorithms, collection, hacktoberfest, java, maven, snippets
Language: Java
Homepage:
Size: 180 KB
Stars: 5
Watchers: 2
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Algorithms

![Algorithms CI](https://github.com/ohbus/Algorithms/workflows/Algorithms%20CI/badge.svg)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ohbus_algorithms&metric=alert_status)](https://sonarcloud.io/dashboard?id=ohbus_algorithms)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ohbus_algorithms&metric=ncloc)](https://sonarcloud.io/dashboard?id=ohbus_algorithms)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=ohbus_algorithms&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=ohbus_algorithms)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ohbus_algorithms&metric=coverage)](https://sonarcloud.io/dashboard?id=ohbus_algorithms)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=ohbus_algorithms&metric=sqale_index)](https://sonarcloud.io/dashboard?id=ohbus_algorithms)

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

**Algorithms using Java built with :heart: using Maven**

## [Contributing](https://github.com/ohbus/algorithms/blob/master/CONTRIBUTING.md)

This repository is contribution friendly. If you'd like to add or improve an algorithm, your contribution is welcome!

Please go through this comprehensive guide to setup the repository in your local enviornment using [this guide CONTRIBUTING.md](https://github.com/ohbus/algorithms/blob/master/CONTRIBUTING.md#contributing-to-algorithms).

If you're an algorithms enthusiast and want to add or improve an algorithm your contribution is welcome! Please be sure to include tests

```zsh

➜  algorithms git:(master) ./mvnw verify

```

### Adding a new algorithm

#### The procedure to add a new algorithm or snippet of code is:

1. If there doesn't already exist an issue, then file a new issue explaining the algorithm/change you want to do.

2. Make sure the algorithm doesn't already exist! We don't want duplicate algorithms.

3. Identify the category folder your algorithm belongs to. For example, a sorting snippet would belong to the `src/main/java/xyz/subho/algorithms/sort` folder. You may also create a new **category** folder if appropriate.

4. Add the algorithm implementation to: `src/main/java/xyz/subho/algorithms/category/FooAlgorithm.java`

5. Add tests for FooAlgorithm in: `src/test/java/xyz/subho/algorithms/category/FooAlgorithmTest.java`

6. Test your algorithm thoroughly.

7. Run **`./mvnw spotless:apply`** to format all Java code according to Google Style Guide.

8. Send pull request for review.

## Running an algorithm implementation

To compile and run any of the algorithms here, you need at least JDK version 11. Maven can make things more convenient for you, but it is not required.

## Running with Maven (recommended)

This project supports the [Maven Wrapper](http://maven.apache.org/plugins/maven-wrapper-plugin/wrapper-mojo.html). The Maven wrapper automatically downloads dependecies at the first time it runs, so expect a delay when running the first command below.

If you are on Windows, use `mvnw` instead of `./mvnw` below.

Run a single algorithm like this:

```zsh

./mvnw compile exec:java -Dexec.mainClass="."

```

For instance:

```zsh

./mvnw compile exec:java -Dexec.mainClass="xyz.subho.algorithms.sort.QuickSort"

```

## Compiling and running with only a JDK

### Create a classes folder

```zsh

cd algorithms

mkdir classes

```

### Compile the algorithm

```zsh

javac -sourcepath src/main/java -d classes src/main/java/ 

```

### Run the algorithm

```zsh

java -cp classes 

```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Subhrodip Mohanta}
📆 🚧

    
_{Souptik Hari}
💻

    
_{SUBHADEEP MAITI}
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!