@xtreamsrl/app-core
v1.2.0
Published
A collection of utilities to help with Node.js app development.
Downloads
434
Readme
@xtreamsrl/app-core
A collection of utilities to help with Node.js app development. It contains the following submodules:
- domain: a collection of utilities to help with domain modeling
- exceptions: a collection of utilities to help with error handling
- pagination: utilities to help with pagination
The library is multi entry point, so you can import from the modules you need.
Installation
npm install @xtreamsrl/app-core
Build
Run nx build app-core
to build the library.
Run unit tests
Run nx test app-core
to execute the unit tests via Jest.
Linting
Run nx lint app-core
to execute the lint via ESLint.
Versioning
Export the GH_TOKEN
environment variable with your GitHub token with at least the repo
scope:
export GH_TOKEN=<YOUR_PERSONAL_GH_TOKEN>
Then run the following command:
lerna version
The GH_TOKEN
is needed to push the version commit and tag to the remote repository and to create the release on GitHub.
For general information about the versioning process, please refer to the root Readme Versioning section.
Publishing
Update your local .npmrc
file to include the following lines:
@xtreamsrl:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
The ${NPM_TOKEN}
placeholder is a npm personal access token publish permissions on the @xtreamsrl
organization.
It can be treated as placeholder to replace with the actual token value, or you can set it as an environment variable:
export NPM_TOKEN=<YOUR_PERSONAL_NPM_TOKEN>
Then run the following command:
npm run lerna-publish