building-nango-functions-locally

Name: building-nango-functions-locally
Availability: InStock
Author: Nango

Build and validate Nango Functions locally in a TypeScript project.

45|32|Updated Sep 23, 2024

Search Tags:#typescript #functions #nango #local-development #tests #dryrun #zero-yaml

Ready to run

npx skills add https://github.com/NangoHQ/integration-templates --skill building-nango-functions-locally

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: building-nango-functions-locally
Source: https://github.com/NangoHQ/integration-templates/tree/main/.agents/skills/building-nango-functions-locally
Command: npx skills add https://github.com/NangoHQ/integration-templates --skill building-nango-functions-locally

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Build Nango Functions locally in a checked-out Zero YAML TypeScript Nango project, enabling you to iterate on actions or syncs with real-world files and a registered entry point.

Core Features & Use Cases

Local function build and validation; index.ts registration; nango dryrun; generated tests; optional deploy for actions or syncs.
Use Case: develop and test new or updated Nango actions or syncs entirely offline before pushing to the remote environment.

Quick Start

Prepare your local Nango project and run the dryrun workflow to validate and generate tests for your actions or syncs.

Frequently Asked Questions about building-nango-functions-locally

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I develop and test Nango functions locally before deploying?▼

You can develop Nango functions locally by building and validating actions or syncs in a checked-out Zero YAML TypeScript project, requiring index.ts registration, dryrun validation, and generated tests before deploying.

What is the Zero YAML approach for local Nango development?▼

The Zero YAML approach enables building and iterating on Nango actions or syncs entirely offline using real-world TypeScript files and a registered index.ts entry point, enforcing local development best practices like dryrun validation and test generation.

Do I need a registered entry point to run a Nango dryrun?▼

Yes, running a Nango dryrun requires local file registration through an index.ts entry point in your checked-out Zero YAML TypeScript project to validate functions and generate tests properly.

Can I validate Nango syncs and actions entirely offline?▼

Yes, you can validate Nango syncs and actions entirely offline by using the local dryrun workflow to test with real-world files and generate tests before pushing to the remote environment.

What are the limitations of building Nango functions locally?▼

Building Nango functions locally requires a checked-out Zero YAML TypeScript project and enforces strict best practices: you must register files in index.ts, pass dryrun validation, and generate tests before optionally deploying actions or syncs.