@betarena/scores-lib
v4.29.0
Published
Global methods, graphQL, types & Declarations for Betarena Scores Platform
Readme
📝 - Package Description
This pacakge is a gateway for developing at WOS - World of Sports, giving access to (but not limited to):
- Global common TS functions
- Typescript declarations (
d.ts) for:- Detailed and accurate PostgreSQL database table schemas (tailored for
Hasura/GraphQLformat) - Detailed endpoint (1) responses & (2) requests from complementary internal backend services
- Detailed and accurate PostgreSQL database table schemas (tailored for
- Wrappers for:
- GraphQL (Hasura)
queries&websocketsinstances - Redis connection
- API for communication with complementary backend services
- GraphQL (Hasura)
, 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) betternode_modules/management when working on other WOS - World of Sports projects simultanously, that depend onscores-lib.
🚢 - Release Flow
This repository uses a PR-based release flow so that main can remain protected.
- Open a regular pull request to
main. - Add exactly one label:
semver:patch,semver:minor, orsemver:major. - Merge the pull request after checks pass.
- GitHub Actions will automatically open a release pull request with the version bump and updated
CHANGELOG.md. - 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
