Dev3 Toolkit is a simple Chrome extension that contains four components targeted at power users and developers.
You will need the following to run this project:
-
Node.js
Install Node.js from here, using your preferred package manager (Choco, Scoop, brew, etc) or using the following commands:
# On Windows winget install OpenJS.NodeJS # or scoop install nodejs # On Linux (Ubuntu) curl -fsSL https://deb.nodesource.com/setup_19.x | sudo -E bash - &&\ sudo apt-get install -y nodejs
-
Clone the repo
-
Copy
.env.example
to.env
and update theVITE_MASTER_KEY
valuecp .env.example .env
Use a random 32-character string for better security. You can generate one securely using the following command:
openssl rand -base64 24
Example key:
VITE_MASTER_KEY="xcQ+U#LIDUS^kY&8BZPCKFV+Sy^xSX7A"
-
Install NPM packages
npm install
-
(Optional) Run the development server
npm run dev
-
Build the extension
npm run build
-
Load the extension in Chrome (or any Chromium-based browser)
- Open the Extension Management page by navigating to
chrome://extensions
. - Enable Developer Mode by clicking the toggle switch next to Developer mode.
- Click the LOAD UNPACKED button and select the
dist
directory.
- Open the Extension Management page by navigating to
-
Profit! ๐
Run the following commands to generate the full documentation based on JSDoc comments in the code.
- Install TypeDoc
npm install --save-dev typedoc
- Generate the documentation with the following command
npm run docs
- The documentation can be found in
docs/index.html
- Prettier - for code formatting
- Tailwind CSS IntelliSense - for autocomplete in Tailwind CSS classes
- ESLint - for linting and error checking
- Auto Complete Tag - for auto-renaming and auto-completing tags in HTML or React