Registry by 514DiscoverCreateRequest
DocsGitHub7

Connector Quickstart

Get up and running with your first connector in under 5 minutes.

Prerequisites

  • Node.js 18+ and npm/pnpm installed
  • Git installed
  • Basic knowledge of TypeScript or Python

1. Clone the Repository

git clone https://github.com/514-labs/registry.git
cd registry

2. Generate Your Connector

Use our scaffold script to create a new connector:

bash -i <(curl https://registry.514.ai/install.sh)   my-api v1 myusername typescript

This creates a new connector with:

  • Name: my-api
  • Version: v1
  • Author: myusername
  • Language: typescript

3. Navigate to Your Connector

cd connector-registry/my-api/v1/myusername/typescript/default

4. Install Dependencies

pnpm install

5. Start Building

Your connector scaffold includes:

  • src/auth/ - Authentication logic
  • src/extract/ - Data extraction logic
  • src/transform/ - Data transformation logic
  • schemas/ - Schema definitions
  • tests/ - Unit tests

6. Test Your Connector

pnpm test

Next Steps