Debate Zone Microservice Common Library

This repository contains the common library for the Debate Zone microservices. It provides a set of reusable components, utilities, and functions that are shared across multiple microservices in the Debate Zone ecosystem.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• License
• Contact

Getting Started

Follow these steps to use the Debate Zone Microservice Common Library in your project.

Prerequisites

• Node.js (version 19.x or higher)
• npm (version 9.x or higher)

Installation

1. Clone the repository:

git clone https://gitlab.com/debate-zone/debate-zone-micro-service-common-library.git

2. Contribute to the repository:
   1. Write code
   2. Write tests
   3. Run tests
   4. Create new branch
   5. Commit changes with message: 5. feat: <message> for new features 6. fix: <message> for bug fixes
   6. Push changes to remote branch
   7. Create merge request
   8. Wait for merge request to be approved
   9. Merge changes to master branch
   10. Delete remote branch
   11. Delete local branch
   12. Repeat

Usage

To use the Debate Zone Microservice Common Library in your project, import the package and use the exported functions.

1. Add line below to your .npmrc file:

@debate-zone:registry=https://gitlab.com/api/v4/packages/npm/

2. Install the package:

npm install @debate-zone/micro-service-common-library --save