README.md

Airbyte Connectors (ESM)

This repository is an ESM version of https://github.com/faros-ai/airbyte-connectors, which is written in CommonJS. If you want to build a source connector that needs to import pure ESM packages, you need something like this. Learn more.

See the READMEs inside destinations/ and sources/ subfolders for more information on each connector.

Component	Code	Installation	Version
Airbyte CDK	faros-airbyte-cdk	npm i faros-airbyte-cdk
Faros Destination	destinations/airbyte-faros-destination	npm i airbyte-faros-destination or docker pull farosai/airbyte-faros-destination
Web3 Analytics Source	sources/airbyte-web3analytics-source	docker pull web3analytics/airbyte-web3analytics-source

Development

1. Install nvm
2. Install Node.js nvm install 16 && nvm use 16
3. Install lerna by running npm install -g lerna
4. Run npm i to install dependencies for all projects (npm run clean to clean all)
5. Run npm run build to build all projects (for a single project add scope, e.g npm run build -- --scope airbyte-faros-destination)
6. Run npm run test to test all projects (for a single project add scope, e.g npm run test -- --scope airbyte-faros-destination)
7. Run npm run lint to apply linter on all projects (for a single project add scope, e.g npm run lint -- --scope airbyte-faros-destination)

👉 Follow our guide on how to develop a new source here.

Other Useful Commands

1. Audit fix npm audit fix
2. Clean your project npm run clean

Read more about lerna here.

Build Docker Images

In order to build a Docker image for a connector run the docker build command and set path and version arguments. For example for Faros Destination connector run:

docker build . --build-arg path=destinations/airbyte-faros-destination --build-arg version=0.0.1 -t airbyte-faros-destination

And then run it:

docker run airbyte-faros-destination