n8n-nodes-friendgrid
This repo contains FriendGrid community nodes for n8n, including a ScreenshotBase node.
To make your custom node available to the community, you must create it as an npm package, and submit it to the npm registry.
If you would like your node to be available on n8n cloud you can also submit your node for verification.
Prerequisites
You need the following installed on your development machine:
- git
- Node.js and npm. Minimum version Node 20. You can find instructions on how to install both using nvm (Node Version Manager) for Linux, Mac, and WSL here. For Windows users, refer to Microsoft's guide to Install NodeJS on Windows.
- Install n8n with:
npm install n8n -g
- Recommended: follow n8n's guide to set up your development environment.
Using this starter
These are the basic steps for working with the starter. For detailed guidance on creating and publishing nodes, refer to the documentation.
- Generate a new repository from this template repository.
- Clone your new repo:
git clone https://github.com/<your organization>/<your-repo-name>.git
- Run
npm i
to install dependencies. - Open the project in your editor.
- Browse the examples in
/nodes
and/credentials
. Modify the examples, or replace them with your own nodes. - Update the
package.json
to match your details. - Run
npm run lint
to check for errors ornpm run lintfix
to automatically fix errors when possible. - Test your node locally. Refer to Run your node locally for guidance.
- Replace this README with documentation for your node. Use the README_TEMPLATE to get started. See below for ScreenshotBase usage.
- Update the LICENSE file to use your details.
- Publish your package to npm.
More information
Refer to our documentation on creating nodes for detailed information on building your own nodes.
ScreenshotBase Node
Capture website screenshots using the ScreenshotBase API.
Credentials
- Create credentials of type
ScreenshotBase API
and enter your API key (https://app.screenshotbase.com/register
)). - Base URL defaults to
https://app.screenshotbase.com/v1
.
Operation
- Get Screenshot
- URL (required)
- File Name (optional)
- Advanced: width, height, format (png/jpeg/webp), fullpage
Notes
- The node performs a GET to
/take
with your key injected by credentials. - Output is the HTTP response. Add a downstream node to persist the image as needed.