# n8n-io/n8n-nodes-starter architecture

> Architecture diagram of the GitHub repository n8n-io/n8n-nodes-starter, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/n8n-io/n8n-nodes-starter
- Repository: https://github.com/n8n-io/n8n-nodes-starter

## Overview

This repository is an n8n community-node starter, with a basic custom-execution example and a declarative GitHub Issues integration. The main workflow is configuring the GitHub node in n8n, choosing a resource and operation, selecting repository or issue values, then making an authenticated GitHub API request. The GitHub example covers issue retrieval and creation, comment retrieval, and searchable dropdowns. The graph also shows shared request and pagination helpers. Source excerpts support the listed wiring; the README documents the broader starter capabilities, but the Example node and credential implementations were not sampled.

Main entry points: [`nodes/GithubIssues/GithubIssues.node.ts`](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/GithubIssues.node.ts) (GitHub Issues node), [`nodes/GithubIssues/resources/issue/index.ts`](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/index.ts) (Issue operations), [`nodes/GithubIssues/shared/descriptions.ts`](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/shared/descriptions.ts) (Resource selectors), [`nodes/GithubIssues/resources/issueComment/index.ts`](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issueComment/index.ts) (Comment operations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_starter["Starter example"]
  node_example["Example node<br/>[Example.node.ts]"]
end

subgraph group_integration["GitHub integration"]
  node_githubnode["GitHub Issues node"]
  node_issueops["Issue operations<br/>[index.ts]"]
  node_commentops["Comment operations<br/>[index.ts]"]
  node_issuegetmany["Issue list options<br/>[getAll.ts]"]
  node_issueget["Get issue options<br/>[get.ts]"]
  node_issuecreate["Create issue options<br/>[create.ts]"]
  node_commentgetmany["Comment list options<br/>[getAll.ts]"]
  node_searchissues["Issue search<br/>[getIssues.ts]"]
  node_searchrepos["Repository search<br/>[getRepositories.ts]"]
  node_searchusers["User search<br/>[getUsers.ts]"]
end

subgraph group_shared["Shared helpers"]
  node_fields["Resource selectors<br/>[descriptions.ts]"]
  node_transport["API transport<br/>[transport.ts]"]
  node_pagination["Link parser<br/>[utils.ts]"]
end

subgraph group_auth["Authentication"]
  node_pat["Access-token credential"]
  node_oauth["OAuth2 credential"]
end

node_author(("Workflow author"))
node_githubapi{{"GitHub API"}}

node_author -.->|"configures"| node_example
node_author -.->|"configures"| node_githubnode
node_githubnode -->|"registers"| node_issueops
node_githubnode -->|"registers"| node_commentops
node_githubnode -->|"registers search"| node_searchissues
node_githubnode -->|"registers search"| node_searchrepos
node_githubnode -->|"registers search"| node_searchusers
node_githubnode -->|"offers auth"| node_pat
node_githubnode -->|"offers auth"| node_oauth
node_issueops -->|"uses selectors"| node_fields
node_issueops -->|"includes options"| node_issuegetmany
node_issueops -->|"includes options"| node_issueget
node_issueops -->|"includes options"| node_issuecreate
node_commentops -->|"uses selectors"| node_fields
node_commentops -->|"includes options"| node_commentgetmany
node_fields -->|"searches issues"| node_searchissues
node_fields -->|"searches repositories"| node_searchrepos
node_fields -->|"searches users"| node_searchusers
node_searchissues -->|"requests through"| node_transport
node_searchrepos -->|"requests through"| node_transport
node_searchusers -->|"requests through"| node_transport
node_transport -->|"sends authenticated requests"| node_githubapi
node_issuegetmany -->|"uses parser"| node_pagination
node_commentgetmany -->|"uses parser"| node_pagination
node_issueops -->|"routes operations"| node_githubapi
node_commentops -->|"routes operation"| node_githubapi

click node_example "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/Example/Example.node.ts"
click node_githubnode "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/GithubIssues.node.ts"
click node_issueops "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/index.ts"
click node_commentops "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issueComment/index.ts"
click node_fields "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/shared/descriptions.ts"
click node_issuegetmany "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/getAll.ts"
click node_issueget "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/get.ts"
click node_issuecreate "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/create.ts"
click node_commentgetmany "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issueComment/getAll.ts"
click node_searchissues "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/listSearch/getIssues.ts"
click node_searchrepos "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/listSearch/getRepositories.ts"
click node_searchusers "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/listSearch/getUsers.ts"
click node_transport "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/shared/transport.ts"
click node_pagination "https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/shared/utils.ts"
click node_pat "https://github.com/n8n-io/n8n-nodes-starter/blob/master/credentials/GithubIssuesApi.credentials.ts"
click node_oauth "https://github.com/n8n-io/n8n-nodes-starter/blob/master/credentials/GithubIssuesOAuth2Api.credentials.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_example toneBlue
class node_githubnode,node_issueops,node_commentops,node_issuegetmany,node_issueget,node_issuecreate,node_commentgetmany,node_searchissues,node_searchrepos,node_searchusers toneAmber
class node_fields,node_transport,node_pagination,node_githubapi toneMint
class node_pat,node_oauth toneRose
class node_author toneIndigo
```

## Components

### Starter example

- [Example node](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/Example/Example.node.ts): `nodes/Example/Example.node.ts`

### GitHub integration

- [GitHub Issues node](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/GithubIssues.node.ts): `nodes/GithubIssues/GithubIssues.node.ts`
- [Issue operations](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/index.ts): `nodes/GithubIssues/resources/issue/index.ts`
- [Comment operations](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issueComment/index.ts): `nodes/GithubIssues/resources/issueComment/index.ts`
- [Issue list options](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/getAll.ts): `nodes/GithubIssues/resources/issue/getAll.ts`
- [Get issue options](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/get.ts): `nodes/GithubIssues/resources/issue/get.ts`
- [Create issue options](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issue/create.ts): `nodes/GithubIssues/resources/issue/create.ts`
- [Comment list options](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/resources/issueComment/getAll.ts): `nodes/GithubIssues/resources/issueComment/getAll.ts`
- [Issue search](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/listSearch/getIssues.ts): `nodes/GithubIssues/listSearch/getIssues.ts`
- [Repository search](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/listSearch/getRepositories.ts): `nodes/GithubIssues/listSearch/getRepositories.ts`
- [User search](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/listSearch/getUsers.ts): `nodes/GithubIssues/listSearch/getUsers.ts`

### Shared helpers

- [Resource selectors](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/shared/descriptions.ts): `nodes/GithubIssues/shared/descriptions.ts`
- [API transport](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/shared/transport.ts): `nodes/GithubIssues/shared/transport.ts`
- [Link parser](https://github.com/n8n-io/n8n-nodes-starter/blob/master/nodes/GithubIssues/shared/utils.ts): `nodes/GithubIssues/shared/utils.ts`

### Authentication

- [Access-token credential](https://github.com/n8n-io/n8n-nodes-starter/blob/master/credentials/GithubIssuesApi.credentials.ts): `credentials/GithubIssuesApi.credentials.ts`
- [OAuth2 credential](https://github.com/n8n-io/n8n-nodes-starter/blob/master/credentials/GithubIssuesOAuth2Api.credentials.ts): `credentials/GithubIssuesOAuth2Api.credentials.ts`

### Other components

- **Workflow author**
- **GitHub API**

## Connections

- Workflow author → Example node: configures (evidence: `README.md`)
- Workflow author → GitHub Issues node: configures (evidence: `README.md`)
- GitHub Issues node → Issue operations: registers (evidence: `nodes/GithubIssues/GithubIssues.node.ts`)
- GitHub Issues node → Comment operations: registers (evidence: `nodes/GithubIssues/GithubIssues.node.ts`)
- GitHub Issues node → Issue search: registers search (evidence: `nodes/GithubIssues/GithubIssues.node.ts`)
- GitHub Issues node → Repository search: registers search (evidence: `nodes/GithubIssues/GithubIssues.node.ts`)
- GitHub Issues node → User search: registers search (evidence: `nodes/GithubIssues/GithubIssues.node.ts`)
- GitHub Issues node → Access-token credential: offers auth (evidence: `nodes/GithubIssues/GithubIssues.node.ts`)
- GitHub Issues node → OAuth2 credential: offers auth (evidence: `nodes/GithubIssues/GithubIssues.node.ts`)
- Issue operations → Resource selectors: uses selectors (evidence: `nodes/GithubIssues/resources/issue/index.ts`)
- Issue operations → Issue list options: includes options (evidence: `nodes/GithubIssues/resources/issue/index.ts`)
- Issue operations → Get issue options: includes options (evidence: `nodes/GithubIssues/resources/issue/index.ts`)
- Issue operations → Create issue options: includes options (evidence: `nodes/GithubIssues/resources/issue/index.ts`)
- Comment operations → Resource selectors: uses selectors (evidence: `nodes/GithubIssues/resources/issueComment/index.ts`)
- Comment operations → Comment list options: includes options (evidence: `nodes/GithubIssues/resources/issueComment/index.ts`)
- Resource selectors → Issue search: searches issues (evidence: `nodes/GithubIssues/shared/descriptions.ts`)
- Resource selectors → Repository search: searches repositories (evidence: `nodes/GithubIssues/shared/descriptions.ts`)
- Resource selectors → User search: searches users (evidence: `nodes/GithubIssues/shared/descriptions.ts`)
- Issue search → API transport: requests through (evidence: `nodes/GithubIssues/listSearch/getIssues.ts`)
- Repository search → API transport: requests through (evidence: `nodes/GithubIssues/listSearch/getRepositories.ts`)
- User search → API transport: requests through (evidence: `nodes/GithubIssues/listSearch/getUsers.ts`)
- API transport → GitHub API: sends authenticated requests (evidence: `nodes/GithubIssues/shared/transport.ts`)
- Issue list options → Link parser: uses parser (evidence: `nodes/GithubIssues/resources/issue/getAll.ts`)
- Comment list options → Link parser: uses parser (evidence: `nodes/GithubIssues/resources/issueComment/getAll.ts`)
- Issue operations → GitHub API: routes operations (evidence: `nodes/GithubIssues/resources/issue/index.ts`)
- Comment operations → GitHub API: routes operation (evidence: `nodes/GithubIssues/resources/issueComment/index.ts`)
