Repository files navigation

A service powering data feeds using theSigned API.

Airseeker v2 is a streamlined redesign of theoriginal Airseeker, focusedexclusively on working with Signed APIs for improved efficiency and simplicity.

1. pnpm install - To install the dependencies.
2. cp config/airseeker.example.json config/airseeker.json - To create the configuration file.
3. cp config/secrets.example.env config/secrets.env - To create the secrets file.

A render of the flowchart can be found below. To edit this document, usediagrams.net toeditairseeker_v2_pipeline.drawio, preferably by cloning the repository and loading the file locally.

Link to theAirseeker specification.

Seeconfiguration for details.

Airseeker usessemantic versioning. The version is specified in thepackage.json file. Thepackage is published to GitHub, NPM, Docker Hub.

To release a new version:

1. pnpm create-release:npm [major|minor|patch] - This will bump the version throughout the repo and commit thechanges.
2. Push tomain. This will trigger thetag-and-release GitHub Actions job and result in 1) the commit being taggedwith the new version, 2) the release being created on GitHub and npm, and 3) the Docker image being built and pushedto Docker Hub.

The docker image can be built by running the following commands from the root directory:

pnpm run docker:build

Create a.env file usingcp .env.example .env and run the docker image locally with:

pnpm run docker:run