@hirehub/shared

v1.2.1

Published

Shared entities and utilities for HireHub microservices

Readme

@hirehub/shared

Shared entities and utilities for HireHub microservices.

šŸ“¦ Installation

npm install @hirehub/shared@^1.0.0

Note: This is a public scoped npm package. Authentication may be required for publishing. See SETUP.md for details.

šŸš€ Quick Start

import { SomeEntity, someUtil } from '@hirehub/shared';

šŸ“ Structure

src/
ā”œā”€ā”€ entities/     # Shared database entities
│   └── index.ts
ā”œā”€ā”€ utils/        # Shared utility functions
│   └── index.ts
└── index.ts      # Main export file

šŸ”§ Development

Building

npm run build

Verifying Setup

npm run verify

Publishing

# Bump version
npm version patch|minor|major

# Publish
npm publish

šŸ“š Documentation

  • Setup & Publishing Guide: See SETUP.md for complete setup, authentication, and publishing instructions

šŸ” Authentication

This package requires npm authentication. Configure .npmrc in each microservice:

@hirehub:registry=https://registry.npmjs.org/
//registry.npmjs.org/:_authToken=${NPM_TOKEN}

See SETUP.md for complete authentication setup.

šŸ“ Versioning

We follow Semantic Versioning:

  • MAJOR: Breaking changes
  • MINOR: New features (backward compatible)
  • PATCH: Bug fixes

šŸ¤ Contributing

  1. Make changes in src/
  2. Build: npm run build
  3. Test locally in a microservice
  4. Bump version: npm version patch|minor|major
  5. Publish: npm publish
  6. Update microservices: npm install @hirehub/shared@latest