https://github.com/graphprotocol/common-ts

Common TypeScript library for use in Graph Protocol components
https://github.com/graphprotocol/common-ts

Last synced: 6 days ago
JSON representation

Common TypeScript library for use in Graph Protocol components

• Host: GitHub
• URL: https://github.com/graphprotocol/common-ts
• Owner: graphprotocol
• License: mit
• Created: 2020-02-11T12:31:58.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T15:19:16.000Z (about 1 month ago)
• Last Synced: 2024-12-11T15:04:46.403Z (11 days ago)
• Language: TypeScript
• Homepage:
• Size: 1.61 MB
• Stars: 26
• Watchers: 28
• Forks: 18
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Common TypeScript library for Graph Protocol components

[![CI](https://github.com/graphprotocol/common-ts/workflows/CI/badge.svg)](https://github.com/graphprotocol/common-ts/actions?query=workflow%3ACI)

[![Coverage](https://codecov.io/gh/graphprotocol/common-ts/branch/master/graph/badge.svg)](https://codecov.io/gh/graphprotocol/common-ts)

## Usage / Documentation

More information can be found in the [`@graphprotocol/common-ts`

README](./packages/common-ts/).

## Development notes

### General notes

- This repository is managed using [Lerna](https://lerna.js.org/) and [Yarn

  workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).

- [Chan](https://github.com/geut/chan/tree/master/packages/chan) is used to

  maintain [changelogs](./packages/common-ts/CHANGELOG.md).

### Install dependencies

```sh

yarn

```

### Build

```sh

yarn prepublish

```

### Test

The following environment variables need to be defined for the test suite to run:

- `POSTGRES_TEST_HOST`

- `POSTGRES_TEST_PORT` (optional)

- `POSTGRES_TEST_USERNAME`

- `POSTGRES_TEST_PASSWORD`

- `POSTGRES_TEST_DATABASE`

After that, the test suite can be run with:

```sh

yarn test

```

### Release

1. Update the changelog(s).

2. Run

   ```sh

   yarn publish

   ```

## Copyright

Copyright © 2020 The Graph Foundation.

Licensed under the [MIT license](LICENSE).