airbyte-connectors
airbyte-connectors copied to clipboard
Airbyte connectors (sources & destinations) + Airbyte CDK for JavaScript/TypeScript
Airbyte Connectors
This repository contains Airbyte connectors used in Faros and Faros Community Edition platforms as well as Airbyte Connector Development Kit (CDK) for JavaScript/TypeScript.
See the READMEs inside destinations/
and sources/
subfolders for more information on each connector.
Development
- Install
nvm
- Install Node.js
nvm install 18 && nvm use 18
- Install
lerna
by runningnpm install -g lerna
- Run
npm i
to install dependencies for all projects (npm run clean
to clean all) - Run
npm run build
to build all projects (for a single project add scope, e.gnpm run build -- --scope airbyte-faros-destination
) - Run
npm run test
to test all projects (for a single project add scope, e.gnpm run test -- --scope airbyte-faros-destination
) - Run
npm run lint
to apply linter on all projects (for a single project add scope, e.gnpm run lint -- --scope airbyte-faros-destination
)
👉 Follow our guide on how to develop a new source here.
Other Useful Commands
- Audit fix
npm audit fix
- 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
Releasing
Create a new GitHub Release. The release workflow will automatically publish the packages to NPM and push Docker images to Docker Hub.