Spock Base SDK

About

The Spock Base SDK serves as the foundational SDK for Spock Analytics servers, providing core functionalities and utilities needed for Spock Analytics projects. This repository helps standardize the base functionalities, which can be shared and reused across various server-side projects.

Features

• Provides reusable core functionality for analytics servers.
• Contains standardized utilities for data management and API handling.
• Includes configuration for workflows, code quality, and testing setups.

Technologies Used

• Node.js: Core runtime environment.
• TypeScript: For type safety and enhanced code maintainability.
• Jest: JavaScript testing framework for unit and integration tests.
• Husky: For managing Git hooks to maintain code quality.
• ESLint & Prettier: For code linting and consistent formatting.

Installation

To use this SDK in your project, follow these steps:

1. Install via npm:

   npm install @spockanalytics/base-sdk

or use Yarn: yarn add @spockanalytics/base-sdk 2. Clone the Repository for Development: If you want to contribute to this SDK, clone the repository: git clone https://github.com/username/spock-base.git 3. Navigate to Project Directory: cd spock-base 4. Install Dependencies: yarn install

Folder Structure

Spock-base/
├── .github/workflows/     # CI/CD workflow configurations
├── .husky/                # Git hooks for ensuring code quality
├── src/                   # Source code for the SDK
│   ├── core/              # Core utilities and classes
│   ├── modules/           # Modularized parts of the SDK
│
├── .eslintrc              # ESLint configuration for linting
├── .gitignore             # Files and directories to ignore in Git
├── LICENSE                # Licensing information
├── README.md              # Documentation for the repository
├── jest.config.js         # Configuration for running tests with Jest
├── package.json           # Project dependencies and scripts
├── tsconfig.json          # TypeScript configuration for compiling
└── yarn.lock              # Yarn lockfile for dependency consistency