1.4.6 • Published 5 months ago
localkit v1.4.6
localkit
The localkit
package is an open-source command-line interface (CLI) designed to streamline your web development workflow. It provides a suite of tools for common tasks, including secure password generation, Base64URL encoding/decoding, UUID creation, OTP management, encryption, hashing, favicon creation, PWA asset generation, and Material Icon installation.
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
Install the CLI Globally
npm install -g localkit
# can be updated with
npm update -g localkit
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 ^v22.11.0
- NPM ^10.9.0
Installation
Clone the repository
git clone git@github.com:your-username/localkit.git
Install the dependencies
npm install
Run it
npm start
Built With
- JavaScript
Running the Tests
# unit tests
npm run test:unit
# integration tests
npm run test:integration
License
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
Deployment
npm publish