Skip to content

README.md

Latest commit

 

History

History
46 lines (31 loc) · 1.82 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.82 KB

@hawk.so/kit

Set of packages for Hawk services development (monorepo).

Packages

  • @hawk.so/utils — shared utilities for Hawk packages.

    • hasValue — check that a value is not undefined, null, or empty string.
    • TimeMs — enum of time intervals in milliseconds (Second, Minute, Hour, Day, Week).

  • @hawk.so/github-sdk — GitHub API client for Hawk.

    • GitHubService — GitHub App (installation, installations, repositories).
    • Create and manage issues, assign Copilot to an issue.
    • OAuth: exchange code for token, refresh token, validate user token.
    • normalizeGitHubPrivateKey — normalize PEM key from env (base64, quotes, \n).
    • Types: GitHubServiceConfig, OAuthTokens, GitHubUser, ValidateUserTokenResult, Repository, Installation, GitHubIssue, IssueData.

Requirements

  • Node.js >= 22.0.0
  • Yarn 4 (Corepack enabled in repo)

Commands

yarn install   # install dependencies
yarn build     # build all packages
yarn lint      # lint (build + eslint across packages)
yarn test      # run tests
yarn clean     # remove dist and tsbuildinfo

License

AGPL-3.0

About CodeX

CodeX is a team of digital specialists around the world interested in building high-quality open source products on a global market. We are open for young people who want to constantly improve their skills and grow professionally with experiments in cutting-edge technologies.

🌐 Join 👋 Twitter Instagram
codex.so codex.so/join @codex_team @codex_team