https://github.com/realfx-code/uid-gen

Generates random ID, for anything!
https://github.com/realfx-code/uid-gen

Last synced: about 2 months ago
JSON representation

Generates random ID, for anything!

• Host: GitHub
• URL: https://github.com/realfx-code/uid-gen
• Owner: RealFX-Code
• Created: 2022-09-27T18:28:24.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-29T12:46:15.000Z (about 2 years ago)
• Last Synced: 2023-03-07T20:39:18.270Z (almost 2 years ago)
• Language: C#
• Homepage:
• Size: 8.73 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# uid

This is the repo for my FOSS, Uid!

- [uid](#uid)

  - [What does it do?](#what-does-it-do)

    - [How it works](#how-it-works)

  - [Contributing](#contributing)

    - [Requirements](#requirements)

    - [Building](#building)

  - [Installation](#installation)

## What does it do?

`uid`, is a program I wrote, that generates a random string of hexadecimal characters.

With just running it, You get a 64 character random string, which is the current unix timestamp, encrypted using AES encryption.

If you pass a string as an argument to `uid`, It'll encrypt that string. It's not gauranteed to be 64 characters then.

I also added an alternate method for generating an ID, By passing the `-v2` or `-v2q` argument. It'll encrypt a 16 character long string, containing the letters between A-Z and numbers between 0-9. It'll generate a 64 character long uid, just with a different input.

You may also pass the `-q` or `-v2q` argument to make it only print out the ID and not the input to the encryption.

For more info on arguments, run `uid -help`.

### How it works

It uses AES encryption to encrypt a string.

By default, without any arguments, it uses the current unix timestamp.

If you choose to run `uid` with the `-v2` flag, it'll encrypt a random string of 16 random ASCII characters.

## Contributing

Simply fork the repo and make a pull request. If I can understand the code, and it's an improvement over what's currently in UID, I'll merge it into the master branch.

### Requirements

You need to have `dotnet-sdk 6.0` installed,

and `bash` (bash has to be at `/usr/bin/bash` for the scripts to work without tinkering.) , only if you want to run the scripts to build/clean your local environment.

With `dotnet-sdk 6.0` and `bash` installed, you're ready to build `uid`!

### Building

I don't use Visual Studio, So I don't know if the `.sln` project file still works, since I've edited the `.csproj` file without using Visual Studio.

Simply run `dotnet build ./UniqueIdentifier-gen.csproj`

Or, To build Release binaries for Linux and Windows, I've written a script (`publish.sh`) that'll build and expose built binaries.

To clean binary files, run the script, `./clean.sh`.

## Installation

Run the script I made to install UID.

```

# The script does require superuser, it'll ask for that.

$ ./install.sh

```

rlfx (c) 2022