📝 - Package Description

This pacakge is a gateway for developing at WOS - World of Sports, giving access to (but not limited to):

1. Global common TS functions
2. Typescript declarations (d.ts) for:
   1. Detailed and accurate PostgreSQL database table schemas (tailored for Hasura/GraphQL format)
   2. Detailed endpoint (1) responses & (2) requests from complementary internal backend services
3. Wrappers for:
   1. GraphQL (Hasura) queries & websockets instances
   2. Redis connection
   3. API for communication with complementary backend services

, which is used internally at WOS - World of Sports and its Javascript/Typescript based projects.

🚀 - Get Started:

npm install @betarena/scores-lib@latest
# OR
# pnpm [..]
# yarm [..]

🧪 - Local Development:

pnpm run 'local/1-click/pnpm'

[!IMPORTANT] It is strongly recommended to use pnpm, for its (1) symlink capabilites and (2) better node_modules/ management when working on other WOS - World of Sports projects simultanously, that depend on scores-lib.

🚢 - Release Flow

This repository uses a PR-based release flow so that main can remain protected.

1. Open a regular pull request to main.
2. Add exactly one label: semver:patch, semver:minor, or semver:major.
3. Merge the pull request after checks pass.
4. GitHub Actions will automatically open a release pull request with the version bump and updated CHANGELOG.md.
5. Merge that release pull request to publish the package to npm and create the GitHub release/tag.

[!NOTE] The automated release pull request is created by GitHub Actions and does not need a semver:* label