scaffold-app

Generate an Atlan connector project scaffold with configuration files and Dockerfile.

26|16|Updated May 23, 2024
One-click install
npx skills add https://github.com/atlanhq/application-sdk --skill scaffold-app
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: scaffold-app
Source: https://github.com/atlanhq/application-sdk/tree/main/.claude/skills/scaffold-app
Command: npx skills add https://github.com/atlanhq/application-sdk --skill scaffold-app

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill streamlines the creation of new Atlan app repositories by generating all necessary boilerplate files, saving development time and reducing manual setup errors.

Core Features & Use Cases

  • Project Initialization: Sets up a complete scaffold with configuration files, Dockerfile, and app structure tailored to the connector type and authentication method.
  • Customizable Boilerplate: Generates code templates for app modules, handlers, contracts, and clients based on user inputs for app name, connector, and auth types.
  • Use Case: A developer needs to rapidly create a new SQL connector for Atlan; using this Skill, they provide basic info and receive a ready-to-develop project structure, enabling faster deployment cycles.

Quick Start

Ask the user for their app name, connector type, and authentication method to generate a ready-to-use Atlan connector scaffold.

Frequently Asked Questions about scaffold-app

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

FAQPage Schema
How do I bootstrap a new Atlan connector project with boilerplate code?

To bootstrap an Atlan connector project, provide the app name, connector type, and authentication method. The Skill generates a complete project structure with configuration files, Dockerfile, app modules, handlers, contracts, and clients tailored to those inputs.

What files are included in an Atlan app scaffold?

An Atlan app scaffold includes configuration files, a Dockerfile, and a structured app directory. It also generates code templates for app modules, handlers, contracts, and clients based on the specified connector and authentication types.

Do I need to manually configure Docker for a new Atlan connector repository?

No, manual Docker configuration is not required. The scaffold automatically generates a Dockerfile along with the project structure, ensuring the environment setup conforms to best practices for immediate development.

Can I customize the boilerplate when initializing an Atlan connector?

Yes, boilerplate is customizable based on your inputs. By specifying the app name, connector type, and authentication method, the generated code templates adapt to fit your specific connector requirements.

What is the best way to standardize multiple Atlan connector repositories?

The best way to standardize Atlan connector repositories is to use an automated scaffolding tool. It ensures all generated files conform to project templates and best practices, reducing manual setup errors and saving development time across multiple connectors.

Why use an automated project initialization tool for Atlan connectors?

Automated project initialization streamlines repository creation by generating all necessary boilerplate files at once. This saves development time and reduces manual setup errors, enabling faster deployment cycles for new SQL or other connector types.