Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/password-generator/password-generator-package

Package with algorithm to generate good passwords
https://github.com/password-generator/password-generator-package

algorithm generator hacktoberfest npm-package package password password-generator security-tools typescript

Last synced: about 22 hours ago
JSON representation

Package with algorithm to generate good passwords

Host: GitHub
URL: https://github.com/password-generator/password-generator-package
Owner: password-generator
License: mit
Created: 2020-08-20T23:03:45.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2021-10-30T19:24:33.000Z (about 3 years ago)
Last Synced: 2024-10-04T22:35:25.137Z (about 1 month ago)
Topics: algorithm, generator, hacktoberfest, npm-package, package, password, password-generator, security-tools, typescript
Language: TypeScript
Homepage:
Size: 69.3 KB
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/password-generator/password-generator-package)

[![NPM Version](https://img.shields.io/npm/v/@password-generator/package.svg?style=flat-square)](https://www.npmjs.com/package/@password-generator/package) [![NPM Monthly Downloads](https://img.shields.io/npm/dm/@password-generator/package.svg?style=flat-square)](https://npmjs.org/package/@password-generator/package)

[![License](https://img.shields.io/github/license/password-generator/password-generator-package?style=flat-square)](LICENSE.md) [![Last Commit](https://img.shields.io/github/last-commit/password-generator/password-generator-package?style=flat-square)](https://github.com/password-generator/password-generator-package/commits/) ![Language Most Used](https://img.shields.io/github/languages/top/password-generator/password-generator-package?style=flat-square) [![Implementations](https://img.shields.io/badge/%F0%9F%92%A1-implementations-8C8E93.svg?style=flat-square)](https://github.com/password-generator/password-generator-package/issues) ![Repository Size](https://img.shields.io/github/repo-size/password-generator/password-generator-package?style=flat-square)

[![Forks](https://img.shields.io/github/forks/password-generator/password-generator-package?style=social)](https://github.com/password-generator/password-generator-package/network/members) [![Stars](https://img.shields.io/github/stars/password-generator/password-generator-package?style=social)](https://github.com/password-generator/password-generator-package/stargazers) [![Watches](https://img.shields.io/github/watchers/password-generator/password-generator-package?style=social)](https://github.com/password-generator/password-generator-package/watchers)

Welcome to password-generator-package 👋


🚧 password-generator-package in production... 🚧


> Package with the algorithm to generate passwords

### 🔖 Table Of Contents

- 📃 [About](#about)

- 🤔 [How To Use](#how-to-use)

- 🚀 [Technologies](#technologies)

- 🌱 [Minimal Requirements](#minimal-requirements)

- 🎇 [Features](#features)

- 💡 [How To Contribute](#how-to-contribute)

- 🤗 [Contributors](#contributors)

- 👤 [Author](#author)

- 🔏 [License](#license)

---

📃 About


This package contains the password generation algorithm, it was created for code reuse and easy maintenance!

[Back To The Top](#title)

---

🤔 How To Use


#### 💻 Desktop

Install package with you package-manager

```sh

yarn add @password-generator/package

```

Import and execute

```typescript

import { generatePassword, Preferences } from '@password-generator/package'

const preferences: Preferences = {

  length: 9,

  initialText: 'abc',

  cases: {

    pronounceable: false,

    uppercase: true,

    lowercase: true,

    numbers: true,

    symbols: true,

  },

}

try {

  const password = generatePassword(preferences);

  console.log(password);

} catch (error) {

  console.error(error.message)

}

```

[Back To The Top](#title)

---

🚀 Technologies


- Typescript

- Node

[Back To The Top](#title)

---

🌱 Minimal Requirements


- NodeJs

- Npm or Yarn

[Back To The Top](#title)

---

🎇 Features


- [x] Create algorithm

- [x] Finish ambient config

- [x] Create actions in repository

[Back To The Top](#title)

---

💡 How To Contribute


- Make a fork of this repository

- Clone to you machine and entry on respective paste

- Create a branch with your resource: `git checkout -b my-feature`

- Commit your changes: `git commit -m 'feat: My new feature'`

- Push your branch: `git push origin my-feature`

- A green button will appear at the beginning of this repository

- Click to open and fill in the pull request information



Contributions, issues and features requests are welcome!


📮 Submit PRs to help solve issues or add features


🐛 Find and report issues


🌟 Star the project




[Back To The Top](#title)

---

🤗 Contributors










[Back To The Top](#title)

---

👤 Author


🤓 **Mikael Rolim de Aquino **

- Github: [@Mikael-R](https://github.com/Mikael-R)

[Back To The Top](#title)

---

🔏 License


Copyright © 2020 [Mikael Rolim de Aquino ](https://github.com/password-generator)

This project is licensed by [MIT License](https://api.github.com/licenses/mit).

[Back To The Top](#title)

---

_This README was generated with 💟 by [readme-template-generator](https://github.com/Mikael-R/readme-template-generator)_