passport-customs-exception v0.0.1
Package boilerplate
Configure package
Change name
field in package.json
and package-lock.json
to be your actual package name
"name": "@passportship/<this-package-name>"
Configure Git
Configure Git Username and Email Address before contributing
Switch the repository ROOT_DIR
and do the following
$ git config user.name "YOUR_NAME YOUR_SURNAME"
$ git config user.email "YOUR_PASSPORT_NAME@passportshipping.com"
The repository-specific settings are kept in the .git/config file under the ROOT_DIR
of the repository.
Clone & Install
Make sure you have access to private GitHub organization passportship
Create a GitHub personal access token. Select repo:
and read:packages
scopes
Clone the repo
$ git clone https://github.com/passportship/Boilerplate-package.git
Username: YOUR_GITHUB_USERNAME
Password: YOUR_TOKEN
Login to NPM Registry (to access Passport private packages)
$ npm login --registry=https://npm.pkg.github.com/
Username: <YOUR_GITHUB_USERNAME>
Password: <YOUR_TOKEN>
Email: (this IS public) <YOUR_PASSPORT_NAME>@passportshipping.com
Logged in as <YOUR_GITHUB_USERNAME> on https://npm.pkg.github.com/.
Install the dependencies
$ npm install
$ npm i -g npx
To watch for changes and compile the package automatically, run
$ npm run dev
Work locally without publishing
First run the following commands in the root of this repo
$ npm link
$ npm run build-ts
Then go to a dependent repository where you want to test your local version of this package (replace with the actual value) and run
$ npm link @passportship/<this-package-name>
To reset that link connection
$ npm i
10 months ago