🚀 Quick Start (Install & Run)

Get started with DocuWriter.ai n8n nodes in just a few steps. Follow these instructions to install the dependencies and run the nodes within your n8n instance.

1. Clone the Repository

git clone https://github.com/DocuWriter-ai/n8n-nodes-docuwriter-ai.git
cd n8n-nodes-docuwriter-ai

2. Install Dependencies

We recommend using pnpm for faster installations and consistent lockfiles.

pnpm install

3. Build & Link for n8n

Compile the TypeScript source into the dist folder and link it into your local n8n:

pnpm build
# In your n8n project folder:
pnpm link ../n8n-nodes-docuwriter-ai/dist

4. Start n8n

Launch n8n with the custom nodes:

n8n start

🎉 You’re all set! The DocuWriter.ai action and DocuWriter.ai Trigger nodes will appear in your n8n editor under the Transform group.

⚙️ Requirements

Ensure your environment meets the following minimum requirements before installation:

Dependency Version Requirement Purpose
🟢 Node.js >= 18.10.0 Runs the n8n workflow engine and custom nodes
📦 pnpm >= 7.18.0 Package manager for installing dependencies

Note: These requirements are enforced via the engines and packageManager fields in package.json.

{
  "engines": {
    "node": ">=18.10.0",
    "pnpm": ">=7.18.0"
  },
  "packageManager": "[email protected]"
}

📦 Package Manager Commands

{
  "commands": {
    "npm": "npm install",
    "yarn": "yarn install",
    "pnpm": "pnpm install",
    "bun": "bun install"
  }
}
  • pnpm is the recommended package manager for this project.
  • Other managers (npm, yarn, bun) will work but may produce different lockfile formats.

🔑 Tip: To verify your versions:

node -v   # should be 18.10.0 or higher
pnpm -v   # should be 7.18.0 or higher