@ngrok/gen-x
v0.1.1
Published
Generate package.json#exports from src
Downloads
712
Keywords
Readme
@ngrok/gen-x
Generate package.json#exports from src
Installation
Install @ngrok/gen-x
to your devDependencies
with your preferred package manager:
| package manager | command | | --------------- | ---------------------------- | | npm | npm install -DE @ngrok/gen-x | | yarn | yarn add -DE @ngrok/gen-x | | pnpm | pnpm add -DE @ngrok/gen-x | | bun | bun add -DE @ngrok/gen-x |
Development
Prerequisites required:
We use direnv to assist you with setting up all of the required tooling.
- Install nvm or your node version manager of choice.
- Ensure that
node 20
is installed. Withnvm
, runnvm install
. - Enable
pnpm
withcorepack
:corepack enable pnpm
- Install
pnpm
withcorepack
:corepack install
- Install project dependencies with
pnpm
:pnpm install
First, install direnv
:
| OS | command | | ------ | ----------------------- | | macOS | brew install direnv | | ubuntu | sudo apt install direnv |
For all other OSes, see the direnv installation guide.
Don't forget to set up direnv integration with your shell.
Next, clone the repo and move into the directory:
git clone https://github.com/ngrok-oss/gen-x.git
cd gen-x
Next, run:
direnv allow
This will install nvm
(if not already installed) as well as set the correct node
and pnpm
versions for you.
It will also run pnpm install
at the end to install all node_modules
.