localkit

localkit

Boost your web development workflow with localkit, an open-source CLI that simplifies common tasks like password generation, Base64URL encoding, UUID creation, OTP management, encryption, hashing, favicon creation, PWA asset generation, and Material Icon installation. Save time and focus on building amazing web apps!

The modules are:

• Password: generate and analyze passwords
• Random Bytes: generate and validate Base64URL encoded sequences of random bytes
• UUID: generate and validate UUIDs (Universally Unique Identifiers)
• OTP: generate OTP (One Time Password) secrets and tokens
• AES256: encrypt and decrypt messages with the AES256 algorithm
• MD5: hash and validate messages with the MD5 Algorithm
• Favicon Builder: build all the favicon files required by modern web apps
• PWA Assets Builder: build all the assets required for a PWA to be published
• Material Icons: download and install the Material Icons on a web application

Getting Started

1. Install the CLI Globally

$ npm install -g localkit

1. Run it with:

$ localkit

Forking Instructions

If you wish to make use of the LocaLKit CLI to perform sensitive operations, I suggest that you fork this repository and lock all dependencies in the package.json file (equivalent to using the --save-exact flag) for security reasons.

Requirements

• GIT
• NodeJS ^v21.0.0
• NPM ^v10.2.0

Installation

1. Clone the repository

$ git clone [e-mail]:your-username/localkit.git

1. Install the dependencies

$ npm install

1. Run it

$ npm start

Deployment

$ npm publish

Built With

• JavaScript

Running the Tests

# Unit Tests
$ npm run test:unit

# Integration Tests
$ npm run test:integration

@TODO

[ ] Implement the JavaScript/Typescript/CSS file template generators

License

MIT

Acknowledgments

• Inquirer.js
• node-aes256
• check-password-strength
• date-fns
• generate-password
• node-md5
• uuid
• otplib
• ytdl
• sharp
• png-to-ico
• ffmpeg
• Material Design Icons

Sources

• Adding favicons in a multi-browser multi-platform world
• How to enhance your PWA with HTML tags for iOS and Android
• Adaptive icon support in PWAs with maskable icons
• Define icons and a theme color
• awesome-meta-and-manifest
• PWABuilder
• pwa-asset-generator
• Material Symbols Guide