Shared API/Functionalities

Overview

Shared API/Functionalities is a collection of shared software components designed to provide a common set of functionalities across multiple projects. It is intended to improve software development efficiency, reduce code duplication, and standardize software components across different projects.

Production

To use Shared API/Functionalities production environment, follow these steps:

1. Install the project as a dependency:

npm i @techforhyper/sports-shared-api

Development Debugging Installation

To use Shared API/Functionalities locally for debugging purposes, follow these steps:

1. Clone the project repository: git clone https://github.com/techforhyper/sports-shared-api.git
2. Navigate to Shared API/Functionalities directory: cd sports-shared-api
3. Install the required dependencies: npm install
4. Link the project for debugging: npm link
5. In your own project's directory, link the Shared API/Functionalities: npm link "@techforhyper/sports-shared-api" Install the linked project in your own project: npm i @techforhyper/sports-shared-api

In Step 5, make sure that you are running the command in your own project's directory, not in the Shared API/Functionalities project directory. This will link the Shared API/Functionalities project to your project.

In Step 6, run the npm i @techforhyper/sports-shared-api command in your own project's directory to install the linked project in your project.

Usage

Before using Shared API/Functionalities, you need to run the init function to initialize the project with the necessary configurations. Here's an example of how to use the init function:

require('@techforhyper/sports-shared-api').init({
  database: {
    host: process.env.DB_HOST,
    user: process.env.DB_USER,
    password: process.env.DB_PASS,
    database: process.env.DB_NAME
  }
})

Replace the database object with the appropriate configuration for your project's database.

To use a component from the Shared API/Functionalities project in your project, import it using require() statements, like this:

const { 
  getBetGroupByIds
} = require('@techforhyper/sports-shared-api/core')

Once you have initialized the project, you can start using the components in your project by importing them with require() statements.