Visao Viewer API
Installation
Install needed dependencies of the project.
pnpm install
Tests
pnpm test
Build
pnpm build
Deploy new version
The first thing to do is to make sure everything is committed. Meaning there are no git pending changes. Once that is done, we need to determine what kind of release we are making (Patch, Minor, Major). Here is a fun article to help us determine what to do.
Patch
Content: Internal fix
Example: Bug fix, Performance improvement, environment or internal tweaks
Policy: Consumers should update their software without hesitation
pnpm patch
Minor
Content: Interface change with full backward compatibility
Example: New feature, Endpoint declared deprecated
Policy: Update your software to get some new features. Nothing will break
pnpm minor
Major
Content: Interface change breaking backward compatibility
Example: Change API endpoint name or signature, Remove an endpoint
Policy: Test your system extensively post update. Migration documents may be in order
pnpm major
Publish on npm
pnpm publish
Issue Tracking
Check this repo to see all the reported issues from our users.
NX Commands
- Build for NPM:
pnpm nx run viewer-api:npmbuild - Version:
pnpm nx run viewer-api:version - PostVersion:
pnpm nx run viewer-api:postversion - Patch:
pnpm nx run viewer-api:patch - Minor:
pnpm nx run viewer-api:minor - Major:
pnpm nx run viewer-api:major