Skip to content

Commit

Permalink
Release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan2076 committed Feb 1, 2024
0 parents commit 1da977d
Show file tree
Hide file tree
Showing 15 changed files with 18,239 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: .NET

# Runs on general and C#-specific branches only
on:
push:
branches:
- main
- 'release/**'
- 'cs/**'

jobs:
build:

strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]

runs-on: ${{ matrix.os }}

steps:
- uses: actions/checkout@v3
- name: Setup .NET
uses: actions/setup-dotnet@v3
with:
dotnet-version: 8.0.x
- name: Restore dependencies
run: dotnet restore ./src/
- name: Build
run: dotnet build ./src/ --no-restore
- name: Test
run: dotnet test ./src/ --no-build -v n
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Visual Studio
.vs/

# Visual Studio Code
.vscode/

# .NET build results
bin/
obj/

# Password file
password.txt
8 changes: 8 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
cmake_minimum_required(VERSION 3.0.0)
project(Password++ VERSION 1.0.0)

add_executable(Password++ ./C++/main.cpp)

set(CPACK_PROJECT_NAME ${PROJECT_NAME})
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
include(CPack)
661 changes: 661 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<h1 align="center">Ultimate PassGen</h1>
<p align="center">A simple but above-the-average password generator written in C#</p>
<p align="center">
<a href="https://github.com/Nathan2076/PasswordGenerator/actions/workflows/dotnet.yml">
<img alt=".NET workflow status badge" src="https://github.com/Nathan2076/PasswordGenerator/actions/workflows/dotnet.yml/badge.svg" /></a>
</p>
<br />

## Overview

This is a simple password generation program written in C#. It features all [Unicode characters](https://www.unicode.org/charts/) and [emoji](https://www.unicode.org/emoji/charts/), with more than 153,000 characters available for your passwords.


## Usage

Download your desired version in the Releases tab on the right, and, with [Windows Terminal](https://github.com/microsoft/terminal) (recommended), PowerShell, or Command Prompt, in the folder you downloaded the program, type `./UltimatePassGen`.

From here, everything is pretty self-explanatory. Type the password length on the first input, hit `Enter`, and it will generate a password for you. To copy it to the clipboard, press C. Alternatively, a file named `password.txt` will be created with the generated password in it, so you can open and copy it with `Ctrl + A` and `Ctrl + C`.


## Examples

![Password generation example](./docs/Example.png)

![Usage in Twitter example](./docs/Twitter_example.gif)

![Usage in Reddit example](./docs/Reddit_example.gif)


## What's to Come

Future plans!

Planned for v1.1.0:
- Uppercase/lowercase letters, numbers, symbols, emoji & Unicode selectors;
- Implementation in C++ for performance & JavaScript for online usage;
- Translation for Portuguese.

Planned for v1.2.0:
- Individual character selector;
- Built-in entropy calculator;


## Building it Yourself

- Download and install the [.NET 8.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0);
- Run the following commands inside a folder of your choice:
```
$ git clone https://github.com/Nathan2076/UltimatePassGen.git
$ cd ./UltimatePassGen/src
$ dotnet build
$ ./bin/Debug/net8.0/UltimatePassGen
```


## License

Ultimate PassGen is licensed under the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html), check [its terms](./LICENSE) before using, distributing, or modifying any parts of this project.


## Credits

This project got some inspirations from [MakeMeAPassword](https://makemeapassword.ligos.net/), by [ligos](https://github.com/ligos). I highly recommend it!
Binary file added docs/Example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Reddit_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/Twitter_example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 1da977d

Please sign in to comment.