Giter VIP home page Giter VIP logo

secrets-factory-password-generator's Introduction

Secrets Factory - Password Generator

forthebadge

Java CI

Generate configurable passwords using lowercase, uppercase, numbers and special characters.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need Java 1.8 installed and Apache Maven 3.6+ configured on your system path.
It's best to use the OpenJDK, Windows users can get binaries from AdoptOpenJDK.

Installing

  1. Clone or download the repository from GitHub:

    git clone https://github.com/Skerwe/secrets-factory-password-generator.git
  2. Compile, test and bundle the application:

    mvn compile package
  3. Execute the application:

    java -cp target/secrets-factory-1.2-RELEASE-shaded.jar za.web.skerwe.factory.SecretsFactory

A default password of 12 lenght will be generated, consisting of 4 uppercase, 4 lowercase, 2 numbers and 2 special characters.

To configure the amount of characters:

java -cp target/secrets-factory-1.2-RELEASE-shaded.jar za.web.skerwe.factory.SecretsFactory -l 4 -u 3 -d 3 -s 2

Under the target/ folder the secrets-factory.jar is the application without dependencies, the secrets-factory-1.2-RELEASE-shaded.jar is bundled with the dependencies.

Running the Tests

The tests use Junit and the Hamcrest assertion library

mvn test

The test will run Checkstyle, JaCoCo and the Surefire test report plugins
Individual commands are listed below.

Generating Reports

Static Code Analysis

  1. PMD static code analyzer

    mvn pmd:pmd

    Results are in the target/pmd.xml file.

  2. Apache Maven Checkstyle Plugin

    mvn checkstyle:checkstyle

    Results are in the target/checkstyle-result.xml file.

Unit Test Report

mvn surefire:test

Results are in the target/surefire-reports/ folder.

Code Coverage

  1. JaCoCo Java Code Coverage Library

  2. Cobertura

Cobertura Maven Plugin

mvn cobertura:cobertura

Javadocs

mvn javadoc:javadoc

Results are in the target/site/apidocs/ folder. See mvn site:run below.

Project Site

Generate and run a static server to serve the site

mvn site:run

Maven Dashboard

mvn site
mvn dashboard:dashboard

Built With

License

This project is licensed under the GNU GPLv3 License - see the LICENSE file for details

secrets-factory-password-generator's People

Contributors

dependabot[bot] avatar skerwe avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.