mirror of
https://github.com/n8n-io/n8n-nodes-starter.git
synced 2025-10-28 22:12:26 -05:00
No description
e1c2f2e46b
I've documented the following in `docs/dev-log.md`: - **Project Context & SDLC:** I analyzed project files (like README and package.json) and the project structure. It looks like this project is in its early stages, using TypeScript, ESLint, and Prettier. I didn't find any immediate signs of CI/CD configuration in the repository. - **Functional Architecture & Structure Audit:** I mapped out the directory structure, identified the main responsibilities of the core modules, and documented my initial thoughts on the architecture. I've made a note to review `HttpBinApi.credentials.ts` later. - **Code Quality & Style Initial Review:** I assessed the coding style, naming conventions, and how JSDoc is being used. I also confirmed the linter and formatter are set up. **Critical Pending Action:** I found that the file `interfaces/SunoTypes.ts` is empty. Adding the necessary TypeScript type definitions for Suno API interactions to this file is a high priority for ensuring type safety and clarity. I focused on the analysis documentation for now, as planned. I also noticed a lot of `console.log` statements that we should review and refactor later. |
||
|---|---|---|
| .vscode | ||
| credentials | ||
| docs | ||
| interfaces | ||
| nodes | ||
| tests | ||
| utils | ||
| .editorconfig | ||
| .env.example | ||
| .eslintrc.js | ||
| .eslintrc.prepublish.js | ||
| .gitignore | ||
| .npmignore | ||
| .prettierrc.js | ||
| CODE_OF_CONDUCT.md | ||
| gulpfile.js | ||
| index.js | ||
| LICENSE.md | ||
| package.json | ||
| README.md | ||
| README_TEMPLATE.md | ||
| tsconfig.json | ||
n8n-nodes-suno-ai
This repository contains a custom n8n node for interacting with the Suno AI music generation service. This node is currently under development.
Prerequisites
You need the following installed on your development machine:
- git
- Node.js and pnpm. 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 node (Development)
These are the basic steps for working with this node. For detailed guidance on creating and publishing nodes, refer to the documentation.
- Clone this repo:
git clone https://github.com/<your organization>/<your-repo-name>.git - Run
npm ito install dependencies. - Open the project in your editor.
- The Suno node is located in
/nodes/Sunoand its credentials in/credentials. - Update the
package.jsonto match your details if necessary. - Run
npm lintto check for errors ornpm lintfixto automatically fix errors when possible. - Test your node locally. Refer to Run your node locally for guidance.
- Once development is complete, you can publish your package to npm.
More information
Refer to n8n's documentation on creating nodes for detailed information on building your own nodes.